fencryption

Crates.iofencryption
lib.rsfencryption
version0.1.13
sourcesrc
created_at2022-11-12 12:22:04.73453
updated_at2023-04-09 16:28:36.747091
descriptionA program to encrypt/decrypt text, files and directories
homepage
repositoryhttps://github.com/valflrt/fencryption-rust
max_upload_size
id713585
size99,648
val (valflrt)

documentation

README

test status license license license

Report Bug
Changelog

Fencryption (binary)

I first built this program with typescript (see fencryption-typescript) but I switched to Rust because typescript was not the most suitable language for this kind of project and also because I wanted to try Rust and low-level programming.

Fencryption is program to encrypt and decrypt files and full directories. Note that this project is at an early stage of development.

THERE IS ABSOLUTELY NO WARRANTY THAT THIS PROGRAM DOES NOT CONTAIN VULNERABILITIES. USE IT AT YOUR OWN RISK.

This program is not supposed to be used in "real conditions" as it is a mere personal project. Although I think above v1.0 (not released yet) the commands encrypt and decrypt should be pretty safe.

Preview

fencryption --help
A program to encrypt/decrypt text and files

Usage: fencryption [OPTIONS] <COMMAND>

Commands:
  encrypt  Encrypt text or files
  decrypt  Decrypt text or files
  help     Print this message or the help of the given subcommand(s)

Options:
  -D, --debug    Enable debug log
  -h, --help     Print help
  -V, --version  Print version
encrypt file
fencryption encrypt file --help
Encrypt files (and directories)

Usage: fencryption encrypt file [OPTIONS] <PATHS>...

Arguments:
  <PATHS>...  Paths of files to encrypt

Options:
  -o, --output-path <OUTPUT_PATH>  Set output path (only supported when one input path is provided)
  -O, --overwrite                  Overwrite output files
  -d, --delete-original            Delete original files after encrypting
  -D, --debug                      Enable debug log
  -h, --help                       Print help
decrypt file
fencryption decrypt file --help
Decrypt files (and directories)

Usage: fencryption decrypt file [OPTIONS] <PATHS>...

Arguments:
  <PATHS>...  Paths of files to encrypt

Options:
  -o, --output-path <OUTPUT_PATH>  Set output path (only supported when one input path is provided)
  -O, --overwrite                  Overwrite output files
  -d, --delete-original            Delete original files after decrypting
  -D, --debug                      Enable debug log
  -h, --help                       Print help
encrypt text
fencryption encrypt text --help
Encrypt text

Usage: fencryption encrypt text [OPTIONS] <TEXT>

Arguments:
  <TEXT>  Text to encrypt

Options:
  -D, --debug  Enable debug log
  -h, --help   Print help
decrypt text
fencryption decrypt text --help
Decrypt text

Usage: fencryption decrypt text [OPTIONS] <ENCRYPTED>

Arguments:
  <ENCRYPTED>  Text to decrypt (in base64)

Options:
  -D, --debug  Enable debug log
  -h, --help   Print help

Limitations/Issues

  • When encrypting files, make sure to encrypt and decrypt them with the same version of fencryption (it is very likely that different versions will not work the same way)

Roadmap

  • Provide better help about commands
  • Add default file encryption features
  • Add stream enc-/decryption features
  • Setup directory recursive mapping
  • Improve log, error handling and cli
  • Implement multithreading
  • Edit encryption process so the output file is smaller
  • Add commands to enc/decrypt text/base64
  • Come up with a stable version (v1.0)

fencryption-lib

The lib used in the fencryption binary. You can take a look, it has some interesting things...

Commit count: 226

cargo fmt