Go crypt is a simple CLI written in Go that allows you to encrypt and decrypt files. It was made by educational proposes and shouldn't be used in production environments.
Of course, in order to test this application, you should have Go installed in your machine. here you can download and follow the instructions to install Go on your machine.
After that, you can download this project using go get command or clonning this repository using git.
Running the following command, you'll be able to pull the project and run it as a binary in your system:
go get -u github.com/LucasFrezarini/go-crypt
go install github.com/LucasFrezarini/go-cryptThen, you can execute it using either:
~/go/bin/go-crypt [command] [flags]or, if you configured the $GOPATH/bin to be in your $PATH, you can just run as a normal command:
go-crypt [command] [flags]First, you have to clone this repository:
git clone https://github.com/LucasFrezarini/go-crypt.gitafter that, you'll have to install the project dependencies using go mod:
go mod downloadthen, you can run the CLI using:
go run main.go [command] [flags]Example of usage:
go-crypt encrypt -f examples/plaintext.txt -o examples/encrypted -s SuperSecretKeygo-crypt decrypt -f examples/encrypted -o examples/decrypted.txt -s SuperSecretKeyThere are two basic commands that you can use in this CLI: encrypt and decrypt. The encryption algoritm used is the AES, and the encryption process is made line by line, and every line is transformed to Base64, avoiding breaking the algoritm when the encryption generates line breaks. The result of the encrypt/decrypt process can be saved into a file or printed on the stdout.
Either encrypt and decrypt commands have two mandatory flags: --secret and --file, and accepts an optional flag called --output:
That's the secret key that will be used to encrypt/decrypt each line of the file. The algorithm uses this key as a base to generate a 32-byte passphrase used in the encryption process. Of course, the same secret-key that you used to encrypt a file should be the one used to decrypt it. Trying to use a invalid key will result in an error.
This one is kinda obvious: this is the path to the file that you want to encrypt. If you pass an invalid/inexistent path, an error will be thrown.
This option allow you to save the encrypted data into a new file. If it is not provided, then the encrypted data will be printed on the system stdout.
The two commands available are self-explanatory: the encrypt and decrypt commands. In the examples showed above it was made clear how to use them too. Also, you can get more details about the commands and flags running:
go-crypt --help