chacha20_poly1305 encryption CLI tool
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
Avril 38dcccd001
rework how 'keygen' works slightly
3 months ago
src rework how 'keygen' works slightly 3 months ago
.gitignore basic profiling 3 months ago
Cargo.lock rework how 'keygen' works slightly 3 months ago
Cargo.toml rework how 'keygen' works slightly 3 months ago
README.md update README 3 months ago
build.rs added explicit_clear 3 months ago
test.sh better write efficiency 3 months ago

README.md

chacha20

A simple chacha20_poly1305 CLI encryption tool

Building

Requires Rust and Cargo to build; also requires OpenSSL v1.1.0 or higher. Run cargo build --release, the binary will be built to ./target/release/chacha20.

Testing

Run cargo test && cargo build && ./test.sh debug to test the program. Alternatively, run ./test.sh after building to test the release build's correctness.

Features

To enable explicit buffer clearing, compile with the option --features explicit_clear.

The explicit_clear feature forces any temporary work buffers to be zeroed out in memory when the corresponding stream is flushed itself. Unless being built with the Rust nightly toolchain, it requires the nonstandard glibc extension explicit_bzero(void*, size_t) to build. On x86 targets with the Rust nightly toolchain, it will also force a cache flush of the corresponding memory address after the zeroing.

This feature is usually not needed, and can cause a slowdown; but it prevents any lingering data being left in the buffer. The unit test remainder() checks the process' memory map for leftover data in the working buffer when testing with this feature enabled. It is still unlikely data will remain even without this feature, depending on your system; you should only use it if you are very paranoid.

Usage

Copies stdin to stdout while encrypting or decrypting with the stream cipher chacha20_poly1305.

Modes

  • Encrypt - Encrypt stdin to stdout
  • Decrypt - Decrypt stdin to stdout
  • Keygen - Generate a random key and IV and print them to stdout

To see a more detailed explenation run chacha20 help.

Formats

The key and IV is expected/generated in base64 format. The key and IV sizes respectively are 32 and 12 bytes.

The ciphertext input and output is raw binary data. You can encode this to text formats if you want with whatever tool you choose (Example with base64 below.)

Example

Encrypting and decrypting a string to binary with randomly generated keys

$ echo "Hello world!" | chacha20 e 2>keys.cck > output.cc20
$ chacha20 d $(cat keys.cck) < output.cc20
Hello world!

The same but with text instead of binary ciphertexts

$ echo "Hello world!" | chacha20 e 2>keys.cck | base64 > output.cc20.b64
$ cat output.cc20.b64 | base64 --decode | chacha20 d $(cat keys.cck)
Hello world!

License

GPL'd with <3