Giter Club home page Giter Club logo

vilicus's Introduction

vilicus

Dashboard

Vilicus (from Latin, meaning overseer or supervisor) is a Bug Bounty API Dashboard. This platform is designed to simplify the process of bug bounty hunting by aggregating data from various sources and presenting it in an easy-to-understand dashboard.

Requirements:

To get Vilicus up and running, you'll need the following:

  • Python3
  • Docker
  • Docker-compose

Installation Steps:

Follow these steps to install and run Vilicus:

  1. Clone the Vilicus repository to your local machine.

    git clone https://github.com/PatrikFehrenbach/vilicus.git
    cd vilicus
    
  2. Start the Docker services.

    docker-compose up
    

    Wait for Docker to pull the necessary images and start the services. This may take a while.

    This will start the server and the application will be accessible at localhost:5000 (or whatever port you've configured).

  3. Visit the dashboard in your web browser.

Optional SecurityTrails integration

The tool has the ability to automatically query the (https://securitytrails.com/) Securitytrails API once a domain has been added. If youwant too enable this feature, you have to rename the env.example to .env and insert your own API Key. It is also recommended to rebuild the container like so docker-compose build --no-cache

Screenshot 2023-07-09 at 19 38 06

Contributing:

Contributions are always welcome. If you find a bug or want to add a new feature, feel free to create a new issue or open a pull request.

License:

This project is open-source and available under the MIT License.

Subdomain and Domain API

Routes

POST /add_domain

Create a new domain. The request body should contain a JSON object with a "name" field.

Request Body:

{ "name": "domain name" }

Responses:

  • 201: 'Domain added successfully!'
  • 400: 'No domain name provided'

POST /update_domain/string:domain_name

Update the name of an existing domain. The request body should contain a JSON object with a "name" field.

Request Body:

{ "name": "new domain name" }

Responses:

  • 200: 'Domain updated successfully!'
  • 400: 'No new domain name provided'
  • 404: 'Domain not found'

POST /delete_domain/string:domain_name

Delete a specific domain by its name.

Responses:

  • 200: 'Domain deleted successfully!'
  • 404: 'Domain not found'

GET /domains/export

Export all domains.

Responses:

  • 200: List of all domains

GET /domains/search?q=test

Search domains by query. The query should be passed as a URL parameter.

Responses:

  • 200: Search results

POST /add_subdomain/string:main_domain

Create a new subdomain for a specific domain. The request body should contain a JSON object with a "subdomain_name" field.

Request Body:

{ "subdomain_name": "subdomain name" }

Responses:

  • 201: 'Subdomain added successfully!'
  • 400: 'No subdomain name provided'
  • 404: 'Main domain not found'
  • 409: 'Conflict'

POST /update_subdomain/string:main_domain/string:subdomain_name

Update the name of an existing subdomain for a specific domain. The request body should contain a JSON object with a "name" field.

Request Body:

{ "name": "new subdomain name" }

Responses:

  • 200: 'Subdomain updated successfully!'
  • 400: 'No new subdomain name provided'
  • 404: 'Main domain not found'
  • 404: 'Subdomain not found'

POST /delete_subdomain/string:main_domain/string:subdomain_name

Delete a specific subdomain for a specific domain.

Responses:

  • 200: 'Subdomain deleted successfully!'
  • 404: 'Main domain not found'
  • 404: 'Subdomain not found'

GET /subdomains/export

Export all subdomains.

Responses:

  • 200: List of all subdomains

GET /string:domain_name/subdomains/export

Export all subdomains of a specific domain.

Responses:

  • 200: List of all subdomains of the specified domain
  • 404: 'Domain not found'

GET /subdomains/search?q=test

Search subdomains by query. The query should be passed as a URL parameter.

Responses:

  • 200: Search results

GET /lastupdated

Fetch all subdomains added in the last hour.

Responses:

  • 200: List of all subdomains added in the last hour

GET /sort_subdomains

Fetch all domains sorted by the count of their subdomains in descending order.

Responses:

  • 200: List of all domains sorted by subdomains count

vilicus's People

Contributors

patrikfehrenbach avatar sim4n6 avatar b1bek avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.