Enkryptit!

This is the binary directory of Enkryptit!, that contains eck.

This project is currently a work in progress. It is not audited for production security.

You can find all the informations on the repo.

Commands

In the WorkSpace, you have access to the following commands :

Tests

Please refer to the test readme.

Fuzzing

Fuzzing is done with cargo-fuzz / libFuzzer, in a standalone crate (fuzz/, excluded from the workspace so it never slows down regular builds or cargo xtask test).

Requires a nightly toolchain (pinned in fuzz/rust-toolchain.toml) and the cargo-fuzz binary installed (cargo install cargo-fuzz).

Fuzz targets live in fuzz/fuzz_targets/:

• decompress — crash-safety for arbitrary bytes across all compression codecs
• compress_roundtrip — compress then decompress must return the exact input
• metadata — postcard deserialization of metadata structures must never panic

Run one (unlimited until Ctrl-C), or bound it for a quick smoke run:

cargo xtask fuzz decompress
cargo xtask fuzz decompress -- -runs=1000
cargo xtask fuzz              # list available targets

Code Layout

src/
├── main.rs                 # entry point, clap CLI definition & dispatch
├── lib.rs                  # library entry point (used by tests)
├── types/                  # enums: CompressionType, KeyType, ParallelismType, KeyParams
│   ├── compression_type.rs
│   ├── key_type.rs
│   ├── parallelism_type.rs
│   └── key_params.rs
├── frontend/               # everything user-facing
│   ├── cli/                # command-line interface
│   │   ├── inspection.rs   # eck inspect
│   │   ├── params_helpers.rs
│   │   └── treatment.rs    # object treatment (single / multiple paths)
│   ├── tui/                # terminal UI (inquire + rfd)
│   │   ├── action.rs
│   │   ├── browse.rs       # file/folder pickers
│   │   ├── help.rs
│   │   ├── input.rs        # TuiInput trait (mockable)
│   │   ├── parameters.rs
│   │   └── treatment.rs
│   ├── treat_output.rs     # renders success / error / info badges
│   └── mod.rs
├── diagnostic/             # logs, reports, errors & error rendering
│   ├── logging/            # EnkryptitLogger (tracing, daily rotation → log.txt)
│   ├── output/             # EnkryptitOutput, diagnostics & snippets (miette)
│   └── report/             # comfy-table Report rendering
├── context/                # EnkryptitContext (password, config resolution)
│   ├── compression.rs
│   └── parallelism.rs      # Auto inference helpers
├── key/                    # key resolution, derivation, storage
│   ├── derivation.rs       # Argon2id key_from_password / derive_key
│   ├── generation.rs
│   ├── resolve.rs          # key from file / OS keyring
│   ├── storage.rs
│   └── mod.rs              # EnkryptitKey + LockedKey (mlock / zeroize)
├── encryption/
│   ├── encryption_primitives.rs  # XChaCha20-Poly1305 chunk encrypt/decrypt, nonce derivation
│   ├── encryption_flow.rs
│   ├── chunk_job/          # EncryptChunkJob / DecryptChunkJob / ChunkResult
│   ├── file.rs
│   ├── file_encryption/    # single & multithreaded file encryption
│   │   ├── single.rs
│   │   ├── multithread.rs
│   │   └── mod.rs
│   ├── folder_encryption/  # folder ↔ .encky archive
│   │   ├── collect_entry.rs
│   │   ├── entry/          # FileEntry handling
│   │   ├── intern_archive_encryption/  # per-entry single/multi treatment
│   │   ├── single.rs       # entry loop
│   │   └── mod.rs
│   └── mod.rs
├── compression.rs          # zstd / lz4 / xz / none (with retry logic)
├── parallelism/            # worker pool for chunk jobs
│   └── pool.rs             # EnkryptitPool
├── parameters/             # persisted parameters (config.json)
│   ├── argon2id_parameters.rs  # static Argon2id params (128 MiB, 3, 1)
│   └── params.rs           # EnkryptitParams load / save
├── metadatas.rs            # ArchiveHeader, MetaDatas, FolderMetadata, FileEntry, MAGIC
├── treatment/              # high-level object treatment & inspection
├── conversions.rs
├── directory.rs            # ProjectDirs (com.olruix.Enkryptit)
└── errors.rs               # EnkryptitError

License

This project is dual-licensed under:

• CeCILL-B License (French law compliant, fully compatible with GNU GPL/Apache)
• Apache License, Version 2.0

Choose the one that best fits your needs.