fencryption 0.1.13

<p align="center">
  <a href="#readme">
    <img src="./docs/assets/logo.png" height="auto">
  </a>

  <p align="center">
    <a href="https://github.com/valflrt/fencryption-rust/actions/workflows/tests.yml"><img alt="test status" src="https://img.shields.io/github/actions/workflow/status/valflrt/fencryption-rust/tests.yml" /></a>
    <a href="https://docs.rs/fencryption/latest/fencryption_lib/"><img alt="license" src="https://img.shields.io/docsrs/fencryption" /></a>
    <a href="https://crates.io/crates/fencryption"><img alt="license" src="https://img.shields.io/crates/v/fencryption?color=informational" /></a>
    <a href="./LICENSE"><img alt="license" src="https://img.shields.io/github/license/valflrt/fencryption-rust" /></a>
  </p>

  <p align="center">
    <a href="https://github.com/valflrt/fencryption-rust/issues/new"><b>Report Bug</b></a>
    <br />
    <a href="https://github.com/valflrt/fencryption-rust/blob/master/CHANGELOG.md"><b>Changelog</b></a>
    <!-- <br />
    <a href="https://github.com/valflrt/fencryption-rust/releases"><b>Download</b></a> -->
  </p>
</p>

- [Fencryption (binary)](#fencryption-binary)
  - [Preview](#preview)
  - [Limitations/Issues](#limitationsissues)
  - [Roadmap](#roadmap)
- [fencryption-lib](#fencryption-lib)

# Fencryption (binary)

> I first built this program with typescript (see [fencryption-typescript](https://github.com/valflrt/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
```

<details>
  <summary>encrypt file</summary>

```
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
```

</details>

<details>
  <summary>decrypt file</summary>

```
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
```

</details>

<details>
  <summary>encrypt text</summary>

```
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
```

</details>

<details>
  <summary>decrypt text</summary>

```
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
```

</details>

## Limitations/Issues

<!-- - Pack files can get pretty huge therefore it is possible that they exceed the maximum file size of some file systems (for example the maximum file size of fat32 is 4GB). -->

- 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

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

<!-- ## Ideas

> things that **_could_** be added in the future

- Packing: makes a file with all the files packed inside (a pack) that is then encrypted
  - Command `pack create` creates a pack from the contents of specified directory
  - Command `pack update` creates a directory where decrypted files (from the encrypted "pack") appear, you can then choose to update the pack with the changes made in the directory or to discard them
  - Command `pack extract` extracts pack to the specified directory -->

# fencryption-lib

The lib used in the fencryption binary. You can [take a look](https://docs.rs/fencryption/latest/fencryption_lib/), it has some interesting things...