~voidraven/qe

a CLI tool for 'quick encryption' with GPG
updated license
Fixed README and comments
check that deps are executable, version bump

refs

master
browse  log 

clone

read-only
https://git.sr.ht/~voidraven/qe
read/write
git@git.sr.ht:~voidraven/qe

You can also use your local clone with git send-email.

#qe

License

#About

This command line tool allows us to Quickly Encrypt a file or folder. The goal is to have a minimal interface where we do not have to memorize a bunch of flags. qe uses 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. While compression is supported, qe does not compress anything by default.

#Dependencies

#Installation

Simply run:

git clone https://git.sr.ht/~voidraven/qe
cd qe
make deps

# as root
make install

# to uninstall
make uninstall

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

Note: When you pass a directory, qe will tar 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 -z gz secret.txt              # gzip secret.txt prior to encryption
qe -z zst /root/secret\ dir/     # compress using zstd prior to encryption
qe -h                            # show this help message
qe -v                            # show version

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

#Configuration

If you would like to set the default behavior of qe, it looks for a configuration file in your home directory ~/.qerc. This will help you by allowing you to skip entering flags manually.

#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.