Skip to content

Latest commit

 

History

History
208 lines (140 loc) · 9.47 KB

README.md

File metadata and controls

208 lines (140 loc) · 9.47 KB
Raw

VCrypture

screen_home

VCrypture is an online service that allows you to encrypt your secret images safely using visual cryptographic algorithms.

What is Visual Cryptography? Visual cryptography is a cryptographic technique which allows visual information (pictures, text, etc.) to be encrypted in such a way that the decrypted information appears as a visual image.

VCrypture is composed of two mainly parts: VCrypture-API and VCrypture-Web. The latter is a web server which provides the front-end as well as forwarding users' requests to the API core, whilst the former aims to perform visual cryptographic operations on images.

Features

screen_about

VCrypture workflow is quite simple. The user can choose between four visual cryptographic algorithms - all visual cryptography schemes are described below. Once the user uploads their secret image and specifies an email address, an email will be sent within a link to the encryption result or, in case of decryption operation, including the decrypted result as attachment.

screen_naorshamir

Visual Cryptography Schemes

screen_services

Naor Shamir

The first of this kind of algorithms. It encrypts your binary images and you will get two shares, both needed to decrypt the secret. Once you get the shares you can opt to decrypt the secret by manually overlaying the two images or by using our decryption form. The encryption is lossy because the original image is converted in binary mode to properly run the algorithm.

naorshamir_example

If you want to learn more about Naor Shamir algorithm, you can read the paper.

Taghaddos Latif

An improved version of Naor-Shamir scheme. It allows you to encrypt grayscale images instead of binary images. The algorithm uses the same size multiplier as Naor-Shamir and also the result is composed by two shares.

taghaddoslatif_example

If you want to learn more about Taghaddos Latif algorithm, you can read the paper.

Dhiman Kasana

Two variations for color images (RGB). You can opt to use EVCT(N, N) where decryption will require all of three shares to retrieve the secret, or EVCT(K, N) where only two of three shares will be needed. That's because the former encrypts one color channel per share, so all shares are needed to reconstruct the pixel's original color. Instead, the latter encrypts two channels per share (RG, RB, GB), so you only need two shares to get the RGB color.

dhimankasana_example_A dhimankasana_example_B dhimankasana_example_C

If you want to learn more about Dhiman Kasana algorithm, you can read the paper.

Dependencies

VCrypture-API

VCrypture-API is developed in Flask. The main libraries and dependecies, which make this tool to work properly, are:

The API core also requires an SMTP server or an email account on a supported provider (i.e., Gmail), to actually return the results via email.

VCrypture-Web

VCrypture-Web is a web application developed in Node.js. The main libraries and dependecies, which make this tool to work properly, are:

  • Express - a Node.js web application framework
  • express-session - an Express middleware for sessions management
  • node-redis - a Node.js Redis client
  • redis-connect - descryption
  • node-fetch - a module that brings Fetch API to Node.js
  • form-data - a library to create readable "multipart/form-data" streams
  • multer - a Node.js middleware for handling multipart/form-data, primarily used for uploading files
  • csurf - a Node.js CSRF protection middleware
  • mustache-express - an Express template engine middleware
  • jQuery - a cross-platform JS library to simplify client-side scripting
  • Bootstrap - a popular front-end framework

Also, a Redis installation is required to store Express sessions.

Installation

You can choose whether to install VCrypture components separately or all-in-one by using Docker Compose. Also, both VCrypture-API and VCrypture-Web come with a Dockerfile to containerize each stand-alone component. Below we show all of the options to correctly install VCrypture. Although, we suggest to opt for the Docker-Compose solution for its simplicity.

VCrypture-API

VCrypture-API requires Python v3.8+ and Flask v1.1.2+ to run.

Manual Setup

In order to host the API core, edit the settings.cfg.example file with your own properties and remove the .example extension:

WEB_ENDPOINT = <url>
STORAGE_FOLDER = <path>

EXECUTOR_TYPE = ('thread'|'process')
EXECUTOR_PROPAGATE_EXCEPTIONS = (True|False)

MAIL_SERVER = <SMTP_ADDRESS>
MAIL_PORT = <SMTP_PORT>
MAIL_USERNAME = <USERNAME>
MAIL_PASSWORD = <PASSWORD>
MAIL_DEFAULT_SENDER = <DEFAULT_SENDER>
MAIL_USE_TLS = (True|False)

Then open your terminal and execute these commands:

$ cd VCrypture/VCrypture-API
$ python3 -m venv venv
$ source venv/bin/activate
$ pip3 install -r requirements.txt
$ export FLASK_APP=app.py && export FLASK_ENV=development
$ flask run

Docker

VCrypture-API comes with a Dockerfile to be easily containerized using Docker. You also have to edit the settings file as described above to continue. Default port is 5050 but you can change it by editing the Dockerfile or by setting the APP_PORT environment variable.

$ cd VCrypture/VCrypture-API
$ docker build -t vcrypture-api .
$ docker run -d -p 5050:5050/tcp --name=vcrypture-api vcrypture-api

VCrypture-Web

VCrypture-Web requires Node.js v14.7.0+, Redis and VCrypture-API to run.

Manual Setup

In order to host the web server, open your terminal and follow these steps:

$ git clone https://github.com/UniCT-WebDevelopment/VCrypture.git
$ cd VCrypture/VCrypture-Web
$ npm install

Edit the config.js.example file with your own properties and remove the .example extension:

const apiIP = 'ip';
const apiPort = port;

module.exports = {
  app: {
    port: <port>,
    apiIP,
    apiPort,
    apiEndpoint: `http://${apiIP}:${apiPort}/api`,
    sessionConfig: {
      secret: '<keyboard cat>',
      resave: false,
      saveUninitialized: true
    }
  },
  redis: {
    host: '<redis_addr>',
    port: <redis_port>,
    ttl: 86400
  }
};

To start the web server execute:

$ npm run

Docker

VCrypture-Web comes with a Dockerfile to be easily containerized using Docker. Edit the config.js.example file and then follow these steps:

$ cd VCrypture/VCrypture-Web
$ docker build -t vcrypture-web .
$ docker run -d -p 80:80/tcp --name=vcrypture-web vcrypture-web

Docker-Compose

VCrypture can be simply deployed by using docker-compose, as we provide the related Dockerfiles as well as docker-compose file. Build both images and then run the following command in the directory containing docker-compose.yml:

$ docker-compose up -d

It will create a Redis, a VCrypture-API and a VCrypture-Web docker container, starting from their images, and setup a network to make them communicate properly. Eventually, all the containers should be properly running and you can access VCrypture from a Web browser at the localhost address.

Authors

This project was developed by Mario Raciti and Giuseppe Tudisco, Computer Science students at Department of Mathematics and Computer Science, University of Catania, Italy. If you have any questions or suggestions feel free to contact us.

Contacts

Todos

  • Add more visual cryptographic algorithms.
  • Use a dedicated SMTP server.
  • Add more options to retrieve results.

Enjoy VCrypture!