diff --git a/README.md b/README.md index 4d26ca9..921cff8 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ DNSRecon is an interactive, passive reconnaissance tool designed to map adversary infrastructure. It operates on a "free-by-default" model, ensuring core functionality without subscriptions, while allowing power users to enhance its capabilities with paid API keys. It is aimed at cybersecurity researchers, pentesters, and administrators who want to understand the public footprint of a target domain. -**Repo Link:** [https://git.cc24.dev/mstoeck3/dnsrecon](https://git.cc24.dev/mstoeck3/dnsrecon) +**Repo Link:** [https://github.com/overcuriousity/dnsrecon](https://github.com/overcuriousity/dnsrecon) ----- @@ -14,6 +14,8 @@ For power users who require more in-depth information, DNSRecon can be configure ----- +----- + ## Features * **Passive Reconnaissance**: Gathers data without direct contact with target infrastructure. @@ -24,6 +26,9 @@ For power users who require more in-depth information, DNSRecon can be configure * **Session Management**: Supports concurrent user sessions with isolated scanner instances. * **Extensible Provider Architecture**: Easily add new data sources to expand the tool's capabilities. * **Web-Based UI**: An intuitive and interactive web interface for managing scans and visualizing results. + * **Export Options**: Export scan results to JSON, a list of targets to a text file, or an executive summary. + * **API Key Management**: Securely manage API keys for various providers through the web interface. + * **Provider Management**: Enable or disable providers for the current session. ----- @@ -56,15 +61,43 @@ DNSRecon queries the following data sources: * Python 3.8 or higher * A modern web browser with JavaScript enabled * A Linux host for running the application + * Redis Server -### 1\. Clone the Project +### 1\. Install Redis + +It is recommended to install Redis from the official repositories. + +**On Debian/Ubuntu:** ```bash -git clone https://git.cc24.dev/mstoeck3/dnsrecon +sudo apt-get update +sudo apt-get install redis-server +``` + +**On CentOS/RHEL:** + +```bash +sudo yum install redis +sudo systemctl start redis +sudo systemctl enable redis +``` + +You can verify that Redis is running with the following command: + +```bash +redis-cli ping +``` + +You should see `PONG` as the response. + +### 2\. Clone the Project + +```bash +git clone https://github.com/overcuriousity/dnsrecon cd dnsrecon ``` -### 2\. Install Python Dependencies +### 3\. Install Python Dependencies It is highly recommended to use a virtual environment: @@ -86,8 +119,9 @@ The `requirements.txt` file contains the following dependencies: * gunicorn * redis * python-dotenv + * psycopg2-binary -### 3\. Configure the Application +### 4\. Configure the Application DNSRecon is configured using a `.env` file. You can copy the provided example file and edit it to suit your needs: