# Shadow Crypt
[](https://crates.io/crates/shadow-crypt)
[](https://docs.rs/shadow-crypt-core)
[](https://docs.rs/shadow-crypt-shell)
[](https://github.com/simon-amadeus/shadow-crypt/actions)
[](#license)
Password-based file encryption with filename obfuscation.
## Features
- **Strong Algorithms**: XChaCha20-Poly1305 cipher, Argon2id key derivation
- **No Storage**: Sensitive data is retained only in memory during operation
- **Memory Safety**: Zeroizes sensitive data in memory after use
- **No Dependencies**: Pure Rust implementation
## Installation
- Ensure you have [Rust and Cargo](https://www.rust-lang.org/tools/install) installed.
### Using Cargo (Recommended)
```bash
cargo install shadow-crypt
```
### From Source
```bash
git clone git@github.com:simon-amadeus/shadow-crypt.git
cd shadow-crypt
cargo install --path .
```
## Usage
### Encrypt Files
```bash
shadow file1.txt file*.jpg
```
### Decrypt Files
```bash
unshadow mzpuTgQmBPJfTAJh.shadow RzxZGbTQAxxBseaI.shadow
```
### List Encrypted Files
```bash
shadows
```
## Documentation
- [📝 Changelog](docs/CHANGELOG.md)
- [📚 API Documentation](https://docs.rs/shadow-crypt)
## Contributing
Contributions are welcome! Please open issues or submit pull requests on [Github](https://github.com/simon-amadeus/shadow-crypt).
## License
Licensed under MIT OR Apache-2.0.
See [LICENSE-APACHE](LICENSE-APACHE) and [LICENSE-MIT](LICENSE-MIT) for full license texts.