rsecure-0.4.0 is not a library.

rsecure

rsecure is a simple and secure command-line tool for AES-GCM file encryption and decryption, built in pure Rust. Ideal for protecting sensitive files, backups, and personal data.

rsecure uses stream encryption and rayon parallelism. The speed of the encryption also depends of your hardware specs (disk speed, CPU speed and number of cores).

example

Installation

curl --proto '=https' --tlsv1.2 -sSfL https://raw.githubusercontent.com/containerscrew/rsecure/main/install.sh | sh

Specific version:

curl --proto '=https' --tlsv1.2 -sSfL https://raw.githubusercontent.com/containerscrew/rsecure/main/install.sh | sh -s -- -v "0.3.0"

[!NOTE] The installation script automatic detects your OS and ARCH and install the correct binary for you (rpm, deb, apk or just a binary in /usr/local/bin). In alpine, install the package apk add gcompat sine the binary is built with glibc and alpine uses musl.

AUR (Arch Linux)

paru -S rsecure # or yay -S rsecure

Homebrew

brew tap containerscrew/tap
brew install --cask rsecure

[!WARNING] Since this binary is not signed by the Apple ecosystem, you will need to run the following command to allow it to run on your system.

xattr -d com.apple.quarantine /opt/homebrew/bin/rsecure

If you still have issues running the binary, I recommend using the cargo installation method or downloading the binary from the releases page. Use the first method (installing via curl and the install.sh script).

Using `cargo`

cargo install rsecure
cargo install rsecure@0.3.3 # specific version

Local build

git clone https://github.com/containerscrew/rsecure.git
cd rsecure
cargo build --release
sudo cp ./target/release/rsecure /usr/local/bin/

Usage

Commands

Command	Description
`rsecure create-key -o /mnt/myusb/rsecure.key`	Generate a new AES-256 key and save it to a file
`openssl rand -out /mnt/myusb/rsecure.key 32`	Alternative: generate a random 256-bit key using OpenSSL
`rsecure encrypt -p /mnt/myusb/rsecure.key -s /home/mydirectory/text_to_encrypt.txt`	Encrypt a single file (`.enc` file is created in the same directory)
`rsecure encrypt -p /mnt/myusb/rsecure.key -s /home/mydirectory/files/`	Encrypt all files in a directory
`rsecure decrypt -p /mnt/myusb/rsecure.key -s /home/mydirectory/text_to_encrypt.txt.enc`	Decrypt a single encrypted file
`rsecure decrypt -p /mnt/myusb/rsecure.key -s /home/mydirectory/files/`	Decrypt all files in a directory
`rsecure encrypt -r -p /mnt/myusb/rsecure.key -s /home/rsecure/dirtoencrypt/`	Encrypt and remove original files (plain text)
`rsecure encrypt -p /mnt/myusb/rsecure.key -s /home/rsecure/dirtoencrypt -e '.git'`	Encrypt all files in a directory excluding `.git/` files

[!WARNING] Saving the key in the same local filesystem where you save the encrypted files is not a good idea. Save the key in a secure location, like a USB drive or a password manager. Or just save it in a root owned directory with strict permissions (will require sudo to use it).

Something like:

sudo rsecure encrypt -p /root/rsecure.key -s /home/dcr/Documents/PrivateDocuments -r

rsecure must be in a PATH directory where root user can execute it. Which means, if you installed it using cargo, you need to add ~/.cargo/bin to the PATH variable in the root user environment. Or just copy the binary to /usr/local/bin/ or any other directory in the PATH.

[!IMPORTANT] By default, rsecure will not delete the source plain files after encryption to avoid data loss. If you want to delete the source files after encryption, use -r flag.

Local dev

Testing encryption and decryption:

git clone https://github.com/containerscrew/rsecure.git
cd rsecure
sh scripts/fake_data.sh # will generate 17gb of fake data in /var/tmp/dummy_files/
rsecure encrypt -p /var/tmp/rsecure.key -s /var/tmp/dummy_files/
rsecure decrypt -p /var/tmp/rsecure.key -s /var/tmp/dummy_files/

Edit the fake_data.sh script to create different types of files and directories for testing.

Benchmark (hyperfine)

cargo install hyperfine
hyperfine --runs 5 'rsecure encrypt -p /var/tmp/rsecure.key -s /var/tmp/dummy_files/'
hyperfine --runs 5 'rsecure decrypt -p /var/tmp/rsecure.key -s /var/tmp/dummy_files/'

TODO

Add support for zip and tar archives.

License

rsecure is distributed under the terms of the GPL3 license.

rsecure 0.4.0