Skip to content

Repository files navigation

CyberHUB

App Logo

An Innovative Web App for Real-Time Data Protection and Breach Prevention

Objective and Scope

Objectives

  1. Develop a robust hash identifier.
  2. Implement an email breach checker utilizing external APIs for real-time analysis.
  3. Create a password breach detection system.
  4. Design a secure message encryption and decryption mechanism

Scope

  1. The project focuses on providing user-friendly interfaces for hash identification, email breach checking, password breach analysis, and message encryption/decryption.
  2. Emphasis on backend processing to ensure data integrity and security.

Installation

Clone the repository:

git clone https://github.com/spaulll/college_project.git

Install dependencies:

pip install -r requirements.txt

Usage

Windows

Using Command Prompt

  1. Development Environment:

    set ENVIRONMENT=development
  2. Production Environment:

    set ENVIRONMENT=production

Using PowerShell

  1. Development Environment:

    $env:ENVIRONMENT="development"
  2. Production Environment:

    $env:ENVIRONMENT="production"

Unix/Linux/macOS

Using Terminal

  1. Development Environment:

    export ENVIRONMENT=development
  2. Production Environment:

    export ENVIRONMENT=production

Run the Flask application:

python app.py

Access the application in your web browser at http://localhost:5000/.


Docker Guide

Build the Docker image:

docker build -t cyberhub .

Run the Docker container:

docker run -e HOST_IP=host.docker.internal -p 5000:5000 cyberhub

For production

docker run -e HOST_IP=host.docker.internal -e ENVIRONMENT=production -p 5000:5000 cyberhub

API Keys Configuration

To use the email breach checker, you need to obtain an API key from Have I Been Pwned and set it up in a .env file.

  • Create a .env file in the root directory of your project and add your API key:
API_KEYs = your_hibp_api_key_here
  • For multiple API Keys separate using commas
API_KEYs = api_key1, api_key2, api_key3

API Endpoints

  • /api/email-breach: Checks if the provided email has been involved in any data breaches.
  • /api/password-breach: Checks if the provided password has been breached.
  • /api/hash-id: Identifies the type of hash provided.
  • /api/massageEncode: Encodes the provided message securely.

Screenshots

home securemessage hashid passwordleak emailleak help

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages