Skip to content

Latest commit

 

History

History
92 lines (69 loc) · 4.34 KB

README.md

File metadata and controls

92 lines (69 loc) · 4.34 KB

QuickBlaze Encryption 👋

GitHub release (latest by date) License: MIT Discord: axtonprice

An extremely simple, one-time view encryption system. Send links anywhere on the internet, and the encrypted message will automatically be destroyed after being viewed once!

Requirements

  • Accessible webserver with PHP support.
  • PHP v7 or higher.
  • PHP MBSTRING module for full UTF-8 support.
  • PHP JSON module for JSON manipulation

Installation

  1. Download the latest version from the releases page.
  2. Upload and extract the contents to your web server. You can also pull the repo with git pull.
  3. Visit your domain installation directory or subdomain https://example.com/quickblaze-encrypt/

Extra: If using MYSQL as storage method:

  • Update the database information in /modules/Database_example.env.
  • Rename the configuration file to Database.env. View example configuration.

⚠️ Don't delete the .version, .config, or .cache files once the installation has completed! They contain necessary version data, configuration data; removing them will cause issues!

System Configurations

Example configuration layout of Modules/Database.env:

{
    "HOSTNAME": "mysql.example.com",
    "USERNAME": "admin",
    "PASSWORD": "admin123",
    "DATABASE": "quickblaze_db"
}

Example configuration of .config:

{ 
  "STORAGE_METHOD": "mysql",
  "LANGUAGE": "en",
  "INSTALLATION_PATH": "https://your-site.dev/quickblaze-encrypt"
}

⚠️ Do not include a trailing slash for the installation path!

How it Works

The user enters the message they would like to encrypt. The system then securely encrypts the message and generates, and returns, an encryption key integrated into a shareable URL. The key can be used to decrypt the encrypted message. The system then creates a new record via the chosen storage method, containing the encrypted data and the encryption key. As soon as the decryption function is called upon, the encryption record will automatically be deleted. This means the encrypted data is now permanently lost and cannot be viewed or accessed.

⚠️ Keep your URL safe, it contains the encryption key! Exposing the URL means anybody will be able to view the encrypted message!

Screenshots

Authors and Contributors

👤 axtonprice - Main Author

Show your support

If you like this project, give a ⭐️ to support us!

📝 License

Copyright © 2022 axtonprice.
This project is MIT licensed.