reconFTW is a tool designed to perform automated recon on a target domain by running the best set of tools to perform scanning and finding out vulnerabilities
Shell bug-bountybugbountybugbounty-tooldnshackingnucleiosintpenetration-testingpentestpentest-toolpentestingreconreconnaissancescannersecuritysecurity-toolssubdomainsubdomain-enumerationvulnerabilities
docs: update README and CONTRIBUTING with new structure
six2dez0a6922c8e412
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.mdindex dc0798b..126033e 100644--- a/CONTRIBUTING.md+++ b/CONTRIBUTING.md@@ -59,6 +59,8 @@ reconftw/│ ├── run_tests.sh # Test runner (--all for integration)│ ├── unit/ # bats-core unit tests│ ├── integration/ # bats-core integration tests+│ ├── security/ # Security/injection tests+│ ├── mocks/ # Tool mocks for isolated testing│ └── fixtures/ # Test data files├── Docker/│ └── Dockerfile # Official Docker image definition@@ -156,7 +158,10 @@ When adding new configuration variables:# Unit tests onlymake test-# Unit + integration tests+# Security tests only+make test-security++# Unit + security testsmake test-all# Via the runner script@@ -164,6 +169,15 @@ make test-all./tests/run_tests.sh --all # unit + integration```+### Pre-commit Hooks++Install pre-commit hooks for automatic linting:++```bash+pip install pre-commit+make setup-dev+```+### Writing TestsTests use [bats-core](https://github.com/bats-core/bats-core). Place unit tests in `tests/unit/` with the `.bats` extension.diff --git a/README.md b/README.mdindex cbdd757..c91bf77 100644--- a/README.md+++ b/README.md@@ -86,6 +86,7 @@ reconFTW leverages a wide range of techniques, including passive and active subd- [💖 Support This Project](#-support-this-project)- [🙏 Thanks](#-thanks)- [📝 Changelog](#-changelog)+- [🛠️ Development](#️-development)- [📜 License](#-license)- [⭐ Star History](#-star-history)@@ -1105,6 +1106,44 @@ See [CHANGELOG.md](CHANGELOG.md) for a detailed list of changes in each release.---+## 🛠️ Development++### Project Structure++```+reconftw/+├── reconftw.sh # Main entry point+├── reconftw.cfg # Configuration file+├── modules/ # Phase modules (what to do)+│ ├── utils.sh # Utilities, sanitization, caching+│ ├── core.sh # Framework core, logging, lifecycle+│ ├── subdomains.sh # Subdomain enumeration+│ ├── web.sh # Web analysis+│ ├── vulns.sh # Vulnerability scanning+│ └── ...+├── lib/ # Pure utility libraries+│ └── validation.sh # Input validation+├── tests/ # Test suite+│ ├── unit/ # Unit tests (bats)+│ └── security/ # Security tests+└── docs/ # Documentation+```++### Running Tests++```bash+make test # Unit tests+make test-security # Security tests+make test-all # All tests+make lint # Shellcheck+```++### Contributing++See [CONTRIBUTING.md](CONTRIBUTING.md) for development guidelines.++---+## 📜 LicensereconFTW is licensed under the [MIT License](LICENSE).