Shhh is a tiny Flask app to create encrypted secrets and share them securely with people. The goal of this application is to get rid of plain text sensitive information into emails or chat logs.
Shhh is deployed here, but it's better for organisations and people to deploy it on their own personal / private server for even better security. You can find in this repo everything you need to host the app yourself.
Or you can one-click deploy to Heroku using the below button. It will generate a fully configured private instance of Shhh immediately (using your own server and Postgres database, for free).
The sender has to set an expiration date along with a passphrase to protect the information he wants to share.
A unique link is generated by Shhh that the sender can share with the receiver in an email, alongside the temporary passphrase he created in order to reveal the secret.
The secret will be permanently removed from the database as soon as one of these events happens:
- the expiration date has passed (max 7 days).
- the receiver has decrypted the message.
- or the amount of tries to open the secret has exceeded (max 10).
The secrets are encrypted in order to make the data anonymous, especially in the database, and the passphrases are not stored anywhere.
Encryption method used: Fernet with password, random salt value and strong iteration count (100 000).
Tip: For added security, avoid telling in Shhh what is the use of the secret you're sharing. Instead, explain this in your email, and copy the Shhh link to it with the passphrase.
Yes, you can find the doc here.
Also, checkout shhh-cli, a Go client to interact with the Shhh API from the terminal.
- Flask, used as our Python backend web-framework.
- Postgres used to store only: the unique links, the encrypted messages, the creation and expiration dates.
- Bulma, the CSS framework.
- Adminer, check database records.
You can find the list of the Python dependencies here, and the list of the frontend dependencies here.
These methods are for development purpose only. For production / public use you might want to use a more secure configuration.
Launch it natively
You will need a Postgres server running on localhost in the background. Create a database named Shhh.
CREATE DATABASE IF NOT EXISTS shhh;git clone https://github.com/smallwat3r/shhh.git && cd shhhWe recommend that you create a Python virtual environment for this project, so you can install the required dependencies.
python -m venv env
source env/bin/activate
pip install -r requirements.txt
pip install -r test-requirements.txt # optionalInstall the frontend dependencies:
# need yarn (brew install yarn) or (sudo apt install yarn)
yarn installStay in the virtual environment created.
You then need to set up a few environment variables. These will be used to configure Flask, as well as the application connection to the database.
export FLASK_APP=shhh
export FLASK_ENV=dev-local
export FLASK_DEBUG=1
export POSTGRES_HOST=localhost
export POSTGRES_DB=shhh
export POSTGRES_USER=<username>
export POSTGRES_PASSWORD=<password>
export POSTGRES_PORT=<port>You can now launch Shhh with:
flask runor using gunicorn:
gunicorn -b :5000 -w 3 wsgi:app --preloadYou can now access Shhh at http://localhost:5000
Launch it with docker-compose (recommended)
You will need Docker and docker-compose installed on your machine.
docker-compose up --build # start app
docker-compose stop # stop appor via Makefile:
make dc-start # start app
made dc-stop # stop appOnce the container image has finished building and starting, you can access:
- Shhh at http://localhost:5000
- Database records using Adminer at http://localhost:8080
make tests # run tests
make lint # run pylint report
make secure # run bandit report
make mypy # run mypy report- @AustinTSchaffer for contributing to set-up a Docker environment.
- @kleinfelter for finding bugs and security issues.
See LICENSE file.
Please report issues or questions here.