hyundotio / magicpad Goto Github PK

MagicPad is an encryption suite for beginners. It is designed to be run standalone via the browser or executable (Electron).

Home Page: https://www.magicpad.io

License: MIT License

JavaScript 35.26% CSS 27.36% HTML 37.34% Shell 0.04%

pgp gpg electron standalone offline pwa encryption privacy security cybersecurity

magicpad's Introduction

MagicPad v1.0.7

MagicPad is an OpenPGP encryption / decryption tool for beginners to handle text messages, files, as well as embed and extract encrypted messages from images. It is designed to be run standalone via the browser. Using PGP as the main encryption engine, the encryption key generated in MagicPad are powerful 4096-bit keys.

Why MagicPad...

No data collection. Can be used offline. Available as a Chrome offline app, and mobile progressive web app. No server-side interaction.
Create, upload, and search for PGP keys.
Easy to understand language. You want to read, write, or attach a file?
Mobile friendly PWA (progressive web app). Can be saved to home screen. Tested on Android and iOS.
Store keys as images as well as hide and reveal encrypted messages in images.

Changelog

Changelog link

Installation

You can run / build MagicPad several ways:

Run it online, or as a PWA, or offline Chrome app on https://www.magicpad.io
Clone and run ./app/index.html via web browser
Clone, build, and run via web browser

npm install
npm run dist

Build explained

In the build procedure, the following happens:

HTML files in the ./html_src folder are combined into a single index.html file in ./app.
JS files in ./app/js are added as <script> tags after </body> tag in index.html. (Step 1 and 2 are controlled by ./build_magicpad.index.js)
index.html is saved to ./app.
All other files are static in ./app and are not altered.

PWA Config

If you want to host your own MagicPad PWA, you must edit the "start_url" property manifest.json file in /src

Packages

Software used:

Node.js
url, path, fs-extra, ncp, and jsdom packages
Openpgp.js
Steganography.js
jQuery
Font and design styling by IBM

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

MIT

magicpad's People

Contributors

Stargazers

Watchers

magicpad's Issues

Add MagicPad Plugins + Chrome Addon to website (www.magicpad.io)

Permalink for Recipient Key

Is your feature request related to a problem? Please describe.
I really like the security benefits of using MagicPad, however I find it difficult to explain to colleagues who are not familiar with PGP how to use MagicPad to send me an encrypted message.

Describe the solution you'd like
I'd love to be able to provide them a link that will automatically import my public key. Perhaps some of the following query parameters:

?email=[email protected]
?email=[email protected]&keyserver=keys.magicpad.io
?fingerprint=${FINGERPRINT}
?key_id=${KEY_ID}

Perhaps even a dedicated/simplified page that is somewhat of a "dropbox" for secrets, based on the aforementioned URL parameters.

Enter your secret for ${FINGERPRINT_OR_EMAIL}:
Press Encrypt
Provide simple instructions to copy/paste the encrypted value to the recipient

Describe alternatives you've considered
Building my own alternative using similar technologies. :P

Additional context
Nah

Regards

Test encryption package in service worker

Running the encryption/decryption engine stalls the UI as it requires a lot of CPU.

I will try to split the workloads between different threads (with service workers) with the UI on the main thread and encryption engine on a service worker.

Organize JS file

organize and comment main.js file