astrosonic / forge

Forensics Oriented Reporting Group Under Encryption
GNU General Public License v3.0
0 stars 7 forks source link
data-integrity directive-protection encryption forge privacy-protection

forge

Forensics Oriented Reporting Group Under Encryption

Topic Image

We made it to the top 10 projects in the 2020 HackTheCrisisIndia IDEAthon

Ideology

This project follows the belief of Sir Abraham Lincoln

You can fool all the people some of the time and some of the people all the time,
But you cannot fool all the people all the time.

Introduction

FORGE or Forensics Oriented Reporting Group Under Encryption is a network system for secure transmission of directives among two or multiple authentic users. It uses asymmetric key cryptography to ensure an end-to-end encryption scenario.

Features

Web application usage

Server-side instructions

  1. Install and upgrade virtualenv if not already done by executing pip3 install virtualenv --user
  2. Clone the repository on your local drive and make it your current working directory
  3. Create a virtual environment by executing virtualenv venv
  4. Activate the virtual environment by executing source venv/bin/activate
  5. Install all dependencies for the project by executing pip3 install -r requirements.txt
  6. Run the project server by executing python3 main.py
  7. When done tinkering, deactivate the virtual environment by executing deactivate
  8. Give stars to the repository if it was helpful

Client-side instructions

  1. Open up a browser and visit <SERVER-IP-ADDRESS>:9696 (default location)
  2. Create account, login, follow people and send protected directives
  3. Safely logout of your account once you are done using it
  4. Give stars to the repository if it was helpful

RESTful API usage

Server-side instructions

  1. Install and upgrade virtualenv if not already done by executing pip3 install virtualenv --user
  2. Clone the repository on your local drive and make it your current working directory
  3. Create a virtual environment by executing virtualenv venv
  4. Activate the virtual environment by executing source venv/bin/activate
  5. Install all dependencies for the project by executing pip3 install -r requirements.txt
  6. Run the project server by executing python3 apim.py
  7. When done tinkering, deactivate the virtual environment by executing deactivate
  8. Give stars to the repository if it was helpful

Client-side instructions

  1. Make sure that the server is reachable and note down the server's URL somewhere
  2. Read about the API endpoints - how to send requests and receive responses in this guide
  3. While developing your application, map these to your actions with HTTP requests
  4. Give stars to the repository if it was helpful

Changelog

You can find all changes listed here

Screenshots

You can find all shiny stuff here

Contribute

The project is currently in diverse development process. The codebase needs cleanup, optimization and documentation so one may find it hard to get their hands into it. Feel free to contact me at akashdeep.dhar@gmail.com if you wish to contribute.