search

khulnasoft / reconpoint

reconPoint: The Ultimate Web Reconnaissance & Vulnerability Scanner 🚀
http://recon.khulnasoft.com/
GNU General Public License v3.0
1 stars 3 forks source link

readme

Recon Point

reconPoint Latest Version License First Timers Only

BlackHat Arsenal Asia 2023 BlackHat Arsenal USA 2022 Open Source Summit 2022 HITB Armory 2021 BlackHat Arsenal USA 2021 Defcon Demolabs 29 2021 BlackHat Arsenal Europe 2020

CodeQL Analysis Build Status

What is reconPoint?

reconPoint is your ultimate web application reconnaissance suite, designed to supercharge the recon process for security pros, pentesters, and bug bounty hunters. It is a go-to tool that simplifies and streamlines reconnaissance, featuring configurable engines, data correlation, continuous monitoring, database-backed reconnaissance data, and an intuitive user interface. reconPoint redefines how you gather critical information about target web applications.

Traditional reconnaissance tools often fall short in configurability and efficiency. reconPoint addresses these shortcomings and emerges as an excellent alternative to existing commercial tools.

Watch reconPoint 2.0-jasper release trailer here!

Documentation

Detailed documentation available at https://recon.khulnasoft.com

Table of Contents

About reconPoint

reconPoint is a game-changing reconnaissance suite. It has turbocharged features for security professionals, penetration testers, and bug bounty hunters. It includes:

🦾 reconPoint performs end-to-end reconnaissance, from subdomain discovery to vulnerability scanning. It supports WHOIS identification, WAF detection, and more, making it a go-to tool for efficient reconnaissance.

🗃️ reconPoint integrates with a database, providing seamless data correlation and organization, allowing you to filter reconnaissance data effortlessly.

🔧 Highly configurable, reconPoint uses a YAML-based configuration system, offering customizable scan engines for all types of recon.

💎  Subscans: Subscan is a game-changing feature in reconPoint, setting it apart as the only open-source tool of its kind to offer this capability. With Subscan, waiting for the entire pipeline to complete is a thing of the past. Now, users can swiftly respond to newfound discoveries during reconnaissance. Whether you've stumbled upon an intriguing subdomain and wish to conduct a focused port scan or want to delve deeper with a vulnerability assessment, reconPoint has you covered.

📃   PDF Reports: In addition to its robust reconnaissance capabilities, reconPoint goes the extra mile by simplifying the report generation process, recognizing the crucial role that PDF reports play in the realm of end-to-end reconnaissance. Users can effortlessly generate and customize PDF reports to suit their exact needs. Whether it's a Full Scan Report, Vulnerability Report, or a concise reconnaissance report, reconPoint provides the flexibility to choose the report type that best communicates your findings. Moreover, the level of customization is unparalleled, allowing users to select report colors, fine-tune executive summaries, and even add personalized touches like company names and footers. With GPT integration, your reports aren't just a report, with remediation steps, and impacts, you get 360-degree view of the vulnerabilities you've uncovered.

🔖    Say Hello to Projects! reconPoint 2.0 introduces a powerful addition that enables you to efficiently organize your web application reconnaissance efforts. With this feature, you can create distinct project spaces, each tailored to a specific purpose, such as personal bug bounty hunting, client engagements, or any other specialized recon task. Each projects will have separate dashboard and all the scan results will be separated from each project, while scan engines and configuration will be shared across all the projects.

⚙️    Roles and Permissions! In reconPoint 2.0, we've taken your web application reconnaissance to a whole new level of control and security. Now, you can assign distinct roles to your team members—Sys Admin, Penetration Tester, and Auditor—each with precisely defined permissions to tailor their access and actions within the reconPoint ecosystem.

🚀   GPT Vulnerability Report Generation: Get ready for the future of penetration testing reports with reconPoint's groundbreaking feature: "GPT-Powered Report Generation"! With the power of OpenAI's GPT, reconPoint now provides you with detailed vulnerability descriptions, remediation strategies, and impact assessments that read like they were written by a human security expert! But that's not all! Our GPT-driven reports go the extra mile by scouring the web for related news articles, blogs, and references, so you have a 360-degree view of the vulnerabilities you've uncovered. With reconPoint 2.0 revolutionize your penetration testing game and impress your clients with reports that are not just informative but engaging and comprehensive with detailed analysis on impact assessment and remediation strategies.

🥷   GPT-Powered Attack Surface Generation: With reconPoint 2.0, reconPoint seamlessly integrates with GPT to identify the attacks that you can likely perform on a subdomain. By making use of reconnaissance data such as page title, open ports, subdomain name etc. reconPoint can advise you the attacks you could perform on a target. reconPoint will also provide you the rationale on why the specific attack is likely to be successful.

🧭  Continuous monitoring: Continuous monitoring is at the core of reconPoint's mission, and it's robust continuous monitoring feature ensures that their targets are under constant scrutiny. With the flexibility to schedule scans at regular intervals, penetration testers can effortlessly stay informed about their targets. What sets reconPoint apart is its seamless integration with popular notification channels such as Discord, Slack, and Telegram, delivering real-time alerts for newly discovered subdomains, vulnerabilities, or any changes in reconnaissance data.

-----------------------------------------------------

Workflow

-----------------------------------------------------

Features

-----------------------------------------------------

Quick Installation

Quick Setup for Ubuntu/VPS

  1. Clone the repository

    git clone https://github.com/khulnasoft/reconpoint && cd reconpoint

  2. Configure the environment

    nano .env

    Ensure you change the POSTGRES_PASSWORD for security.

  3. (Optional) For non-interactive install, set admin credentials in .env

    DJANGO_SUPERUSER_USERNAME=yourUsername
DJANGO_SUPERUSER_EMAIL=YourMail@example.com
DJANGO_SUPERUSER_PASSWORD=yourStrongPassword

    If you need to carry out a non-interactive installation, you can setup the login, email and password of the web interface admin directly from the .env file (instead of manually setting them from prompts during the installation process). This option can be interesting for automated installation (via ansible, vagrant, etc.).

    • DJANGO_SUPERUSER_USERNAME: web interface admin username (used to login to the web interface).

    • DJANGO_SUPERUSER_EMAIL: web interface admin email.

    • DJANGO_SUPERUSER_PASSWORD: web interface admin password (used to login to the web interface).

  4. Adjust Celery worker scaling in .env

    MAX_CONCURRENCY=80
MIN_CONCURRENCY=10

    MAX_CONCURRENCY: This parameter specifies the maximum number of reconPoint's concurrent Celery worker processes that can be spawned. In this case, it's set to 80, meaning that the application can utilize up to 80 concurrent worker processes to execute tasks concurrently. This is useful for handling a high volume of scans or when you want to scale up processing power during periods of high demand. If you have more CPU cores, you will need to increase this for maximised performance.

    MIN_CONCURRENCY: On the other hand, MIN_CONCURRENCY specifies the minimum number of concurrent worker processes that should be maintained, even during periods of lower demand. In this example, it's set to 10, which means that even when there are fewer tasks to process, at least 10 worker processes will be kept running. This helps ensure that the application can respond promptly to incoming tasks without the overhead of repeatedly starting and stopping worker processes.

    These settings allow for dynamic scaling of Celery workers, ensuring that the application efficiently manages its workload by adjusting the number of concurrent workers based on the workload's size and complexity.

    Here is the ideal value for MIN_CONCURRENCY and MAX_CONCURRENCY depending on the number of RAM your machine has:

    • 4GB: MAX_CONCURRENCY=10
    • 8GB: MAX_CONCURRENCY=30
    • 16GB: MAX_CONCURRENCY=50

    This is just an ideal value which developers have tested and tried out and works! But feel free to play around with the values. Maximum number of scans is determined by various factors, your network bandwidth, RAM, number of CPUs available. etc

  5. Run the installation script:

    sudo ./install.sh

    For non-interactive install: sudo ./install.sh -n

    Note: If needed, run chmod +x install.sh to grant execution permissions.

reconPoint can now be accessed from https://127.0.0.1 or if you're on the VPS https://your_vps_ip_address

Unless you are on development branch, please do not access reconPoint via any ports

Installation on Other Platforms

For Mac, Windows, or other systems, refer to our detailed installation guide https://recon.khulnasoft.com/install/detailed/

Installation Video Tutorial

If you encounter any issues during installation or prefer a visual guide, one of our community members has created an excellent installation video for Kali Linux installation. You can find it here: https://www.youtube.com/watch?v=7OFfrU6VrWw

Please note: This is community-curated content and is not owned by reconPoint. The installation process may change, so please refer to the official documentation for the most up-to-date instructions.

Updating

  1. To update reconPoint, run:

    cd reconpoint &&  sudo ./update.sh

    If update.sh lacks execution permissions, use:

    sudo chmod +x update.sh

-----------------------------------------------------

Community-Curated Videos

reconPoint has a vibrant community that often creates helpful content about installation, features, and usage. Below is a collection of community-curated videos that you might find useful. Please note that these videos are not official reconPoint content, and the information they contain may become outdated as reconPoint evolves.

Always refer to the official documentation for the most up-to-date and accurate information. If you've created a video about reconPoint and would like it featured here, please send a pull request updating this table.

Video Title Language Uploader Date Link
reconPoint Installation on Kali Linux English Secure the Cyber World 2024-02-29 Watch
Resultados do ReconPoint - Automação para Recon Portuguese Guia Anônima 2023-04-18 Watch
reconPoint Introduction Moroccan Arabic Th3 Hacker News Bdarija 2021-07-27 Watch

We appreciate the community's contributions in creating these resources.

-----------------------------------------------------

Screenshots

Scan Results

General Usage

Initiating Subscan

Recon Data filtering

Report Generation

Toolbox

Adding Custom tool in Tools Arsenal

-----------------------------------------------------

Contributing

We welcome contributions of all sizes! The open-source community thrives on collaboration, and your input is invaluable. Whether you're fixing a typo, improving UI, or adding new features, every contribution matters.

How you can contribute:

To get started:

  1. Check our Contributing Guide
  2. Pick an open issue or propose a new one
  3. Fork the repository and create your branch
  4. Make your changes and submit a pull request

Remember, no contribution is too small. Your efforts help make reconPoint better for everyone!

-----------------------------------------------------

Submitting issues

When submitting issues, provide as much valuable information as possible to help developers resolve the problem quickly. Follow these steps to gather detailed debug information:

  1. Enable Debug Mode:

    • Edit web/entrypoint.sh in the project root

    • Add export DEBUG=1 at the top of the file:

      #!/bin/bash

export DEBUG=1

python3 manage.py migrate
python3 manage.py runserver 0.0.0.0:8000

exec "$@"

    • Restart the web container: docker-compose restart web

  2. View Debug Output:

    • Run make logs to see the full stack trace
    • Check the browser's developer console for XHR requests with 500 errors

  3. Example Debug Output:

    
web_1          |   File "/usr/local/lib/python3.10/dist-packages/celery/app/task.py", line 411, in __call__
web_1          |     return self.run(*args, **kwargs)
web_1          | TypeError: run_command() got an unexpected keyword argument 'echo'

  4. Submit Your Issue:

    • Include the full stack trace in your GitHub issue
    • Describe the steps to reproduce the problem
    • Mention any relevant system information

  5. Disable Debug Mode:

    • Set DEBUG=0 in web/entrypoint.sh
    • Restart the web container

By providing this detailed information, you significantly help developers identify and fix issues more efficiently.

-----------------------------------------------------

First-time Open Source contributors

reconPoint is an open-source project that welcomes contributors of all experience levels, including beginners. If you've never contributed to open source before, we encourage you to start here!

Your contribution, no matter how small, is valuable to us.

-----------------------------------------------------

reconPoint Support

Before seeking support:

If you still need assistance:

Please note:

-----------------------------------------------------

Support and Sponsoring

reconPoint is a passion project developed in my free time, alongside my day job. Your support helps keep this project alive and growing. Here's how you can contribute:

Your support, whether through donations or simply giving a star, tells me that reconPoint is valuable to you. It motivates me to continue improving and adding features to make reconPoint the go-to tool for reconnaissance.

Thank you for your support!

-----------------------------------------------------

Reporting Security Vulnerabilities

We appreciate your efforts to responsibly disclose your findings and will make every effort to acknowledge your contributions.

To report a security vulnerability, please follow these steps:

  1. Do Not disclose the vulnerability publicly on GitHub issues or any other public forum.

  2. Go to the Security tab of the reconPoint repository.

  3. Click on "Report a vulnerability" to open GitHub's private vulnerability reporting form.

  4. Provide a detailed description of the vulnerability, including:

    • Steps to reproduce
    • Potential impact
    • Any suggested fixes or mitigations (if you have them)

  5. I will review your report and respond as quickly as possible, usually within 48-72 hours.

  6. Please allow some time to investigate and address the vulnerability before disclosing it to others.

We are committed to working with security researchers to verify and address any potential vulnerabilities reported to us. After fixing the issue, we will publicly acknowledge your responsible disclosure, unless you prefer to remain anonymous.

Thank you for helping to keep reconPoint and its users safe!

-----------------------------------------------------

License

Distributed under the GNU GPL v3 License. See LICENSE for more information.

-----------------------------------------------------

Note: Parts of this README were written or refined using AI language models.