reNgine

An automated recon framework for web applications
Contribute . What's new · Report Bug · Request Feature

Table of Contents

• About reNgine
  • What is reNgine
  • What it is not
  • Screenshots
• Getting Started
  • Prerequisites
  • Installation
  • Generate SSL Certificate
  • Building reNgine
  • Register Account
  • Update reNgine
• Usage
• Contributing
• License
• Acknowledgements & Credits

About reNgine

reNgine is an automated reconnaissance framework meant for information gathering during penetration testing of web applications. reNgine has customizable scan engines, which can be used to scan the domains, endpoints, or gather information. The beauty of reNgine is that it gathers everything in one place. It has a pipeline of reconnaissance, which is highly customizable.

reNgine can be very useful when you want to perform the reconnaissance, gather endpoints, directory and file search, grab screenshots, and gather all the results in one place.

Suppose, if you have a domain hackerone.com, reNgine can perform the scan based on your scan engines, gather all the results in one place. reNgine makes it possible for use cases like, "I want to search the subdomain which has page title "Dashboard" and has page status as 200, and I quickly want to have a look at the screenshot".

Another use-case could be, "I want to list all subdomains that use PHP, and the HTTP status is 200!"

On the endpoints part, reNgine is capable of gathering the URL endpoints using tools like gau, hakrawler which gathers URL from many sources like common crawl, Wayback engine, etc.

reNgine also makes it possible for the use case like, "search the URLs that have extension .php and HTTP status is 200!"

Suppose if you are looking for open redirection, you can quickly search for =http and look for HTTP status 30X, this will give high accuracy of open redirection with minimal efforts.

Demo

Click below to watch the demo

What it is not

reNgine is not a:

• Vulnerability scanner!
• Reconnaissance with high accuracy (No! reNgine, uses other open-source tools, to make this pipeline possible. The accuracy and capability of reNgine is also dependent on those tools)
• Speed oriented recon framework with immediate results

Screenshots

Scan results

Gathered Endpoints

Of course, at this point, reNgine does not give the best of the best result compared to other tools, but reNgine has certainly minimal efforts. Also, I am continuously adding new features. You may help me on this journey by creating a PR filled with new features and bug fixes. Please have a look at the Contributing section before doing so.

Flow

Getting Started

To get a local copy up and running, follow these simple example steps.

git clone https://github.com/yogeshojha/rengine.git
cd rengine

Prerequisites

• Docker
  • Install docker based on your OS from here
• docker-compose
  • Installation instructions for docker-compose from here
• make

Installation

Installation instructions has been changed, please read the documentation carefully.

There are currently two ways of setting up the reNgine. Using Makefile is the easiest and is recommended:

If you are setting up inside VPS with https, Makefile makes process so much simpler.

The dotenv file should be updated when setting up reNgine, for example:

AUTHORITY_NAME=reNgine
AUTHORITY_PASSWORD=nSrmNkwT
COMPANY=reNgine
DOMAIN_NAME=recon.example.com
COUNTRY_CODE=US
STATE=Georgia
CITY=Atlanta

Edit the file using your favourite editor (e.g. nano .env or vim .env).

Then use the make cert command to generate the certificate (inside the secrets/certs folder). Assuming that you are inside the reNgine directory, generate the certificates using the following command.

Generate Certificates

make certs

Once certificates are generated, you can run reNgine with https.

Build reNgine

make build

The build process may take some time.

Alternatively, you also can run the project with pre-built Docker images (with 2FA enabled, you have to create a new personal access token with read:packages scope):

make pull

Usage

⚠️ reNgine does fingerprinting, port scanning, and banner grabbing, which might be illegal in some countries. Please make sure you are authorized to perform reconnaissance on the targeted domain before using this tool.

If build process is successful, you can run reNgine by using the command

make up

The web application can then be accessed from https://127.0.0.1, or on your VPS, https://your_ip

Registering Account

Once the application is up and running, you need an account for reNgine:

make username

You may now enter your username and password. Remember to keep a secure password.

How to update

We may add new features and fixes regularly. To get the latest version of reNgine up and running, you need to follow the following steps:

• Get the latest changes Assuming that you are inside reNgine directory:

git pull

• Build the latest changes

make build

That is all, you can then run make up to run the latest version of reNgine.

Contributing

Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated. Your contributions could be as simple as fixing the indentations or fixing UI to as complex as bringing new modules and features.

See contributing guide to get started.

First-time Open Source contributors

Please note that reNgine is beginner-friendly. If you have never done any open-source yet, we encourage you to do so. We will be happy and proud of your first PR ever.

You can begin with resolving any open issues.

License

It is distributed under the GNU GPL v3 license License. See LICENSE for more information.

Acknowledgements and Credits

reNgine is just a pipeline of recon. reNgine would not have been possible without the following individuals/organizations.

• Amass: OWASP
• httpx, subfinder, naabu: ProjectDiscovery
• Sublist3r: Ahmed Aboul-Ela
• assetfinder: Tom Hudson
• gau: Corben Leo
• hakrawler : Luke Stephens
• dirsearch: maurosoria
• subjack haccer

Also, some of the icons and images used herein reNgine are from Freepik and Flaticon.