a CLI tool for 'quick encryption' with GPG

lotus 7e3d8e7ad0 Added argon2 kdf to process password for gpg. Updated README. Version bump. 1 hour ago
shunit2 @ ba130d69bb a86f8a990e added support to automatically tar+gzip and directory prior to encryption, updated readme, update manpages, added submodule for shunit2, started test files, added make test target 1 day ago
tests a86f8a990e added support to automatically tar+gzip and directory prior to encryption, updated readme, update manpages, added submodule for shunit2, started test files, added make test target 1 day ago
.gitignore 7840e90d3c added gitignore, updated readme, fixed makefile 7 months ago
.gitmodules a86f8a990e added support to automatically tar+gzip and directory prior to encryption, updated readme, update manpages, added submodule for shunit2, started test files, added make test target 1 day ago
LICENSE.md 839e434908 first commit 10 months ago
NOTES.md 7e3d8e7ad0 Added argon2 kdf to process password for gpg. Updated README. Version bump. 1 hour ago
README.md 7e3d8e7ad0 Added argon2 kdf to process password for gpg. Updated README. Version bump. 1 hour ago
makefile 6b376296bb Replaced OpenSSL with GPG, updated documentation, added notes, added more comments in code, removed uneeded code for algo selection 23 hours ago
qe.1 6b376296bb Replaced OpenSSL with GPG, updated documentation, added notes, added more comments in code, removed uneeded code for algo selection 23 hours ago
qe.sh 7e3d8e7ad0 Added argon2 kdf to process password for gpg. Updated README. Version bump. 1 hour ago

README.md

qe

License

Installation

Simply run:

git clone https://git.zerohack.xyz/lotus/qe.git
cd qe
# as root
make install

# to uninstall
make uninstall

# to run development unit tests (pulls down shunit2)
git submodule init
git submodule update

There are no dependencies other than GPG and argon2. We use AES256 symmetric cipher. GPG's default key stretching in symmetric mode is relatively weak. To alleviate this issue we derive our key from argon2 first, then pass it to GPG. I have made an effort to keep this tool as portable as possible. Should work with any POSIX shell.

Note: When you pass a directory, qe will tar and gzip it prior to encryption.

Usage

qe secret.txt                    # encrypt secret.txt
qe /root/secret\ dir/            # encrypt the directory 'secret dir'
qe secret.txt.gpg                # decrypt secret.txt.gpg
qe -h                            # show this help message
qe -v                            # show version

# qe expects encrypted files to end with the .gpg extension

Technical Notes

Read More

License / Disclaimer

This project is licensed under the 3-clause BSD license. (See LICENSE.md) I take no responsibility for you blowing stuff up.