https://github.com/mikesposito/secured
🔐 A CLI tool to encrypt and decrypt large amounts of files in a breeze
https://github.com/mikesposito/secured
blazingly-fast chacha20 cipher cli encryption rust tools
Last synced: 6 months ago
JSON representation
🔐 A CLI tool to encrypt and decrypt large amounts of files in a breeze
- Host: GitHub
- URL: https://github.com/mikesposito/secured
- Owner: mikesposito
- License: mit
- Created: 2023-11-29T18:14:42.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-03-25T22:38:13.000Z (over 1 year ago)
- Last Synced: 2025-04-13T11:12:42.736Z (6 months ago)
- Topics: blazingly-fast, chacha20, cipher, cli, encryption, rust, tools
- Language: Rust
- Homepage:
- Size: 658 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# secured
[![Crates.io][crates-badge]][crates-url]
![Build and test][build-status-url]
[![MIT licensed][mit-badge]][mit-url]
[](https://github.com/mikesposito/secured/issues)[crates-badge]: https://img.shields.io/crates/v/secured.svg
[crates-url]: https://crates.io/crates/secured
[mit-badge]: https://img.shields.io/badge/license-MIT-blue.svg
[mit-url]: https://github.com/mikesposito/secured/blob/main/LICENSE
[build-status-url]: https://github.com/mikesposito/secured/actions/workflows/build-lint-test.yml/badge.svgA very fast CLI tool for encryption and decryption of large amounts of data

> [!WARNING]
> As this crate is under early development, APIs are rapidly changing, and so is the documentation.
## Features
- **Encryption and Decryption**: Easily encrypt and decrypt files with password or a pre-generated encryption key.
- **Key Derivation**: Generate encryption keys from passwords with customizable iterations and salt.
- **File Inspection**: Inspect details of secured files.
## Installation
To use **secured** as a CLI tool or integrate it into your Rust project, ensure you have Rust installed, then:
### As a CLI tool
```sh
cargo install secured
```
### As a Library
```sh
cargo add secured
```
## Usage
### Encrypting a Single File
Encrypt a single file with a password. If no password is provided, the tool will prompt you for it.
```sh
secured encrypt secret.txt
```
### Decrypting a Single File
Decrypt a single file with a password. If no password is provided, the tool will prompt you for it.
```sh
secured decrypt secret.txt.secured
```
### Encrypting/Decrypting Multiple Files with Glob Patterns
Use glob patterns to encrypt or decrypt multiple files with a single command.
```sh
secured encrypt data/*.txt
secured decrypt data/*.txt.secured
```
### Generating Encryption Key
Generate an encryption key from a password with customizable iterations and salt.
```sh
secured key --password my_secret_password --iterations 1000000 --salt abcdef1234567890
```
### Inspecting Secured Files
Inspect details of one or more secured files.
```sh
secured inspect secret.txt.secured
secured inspect data/*.txt.secured
```
## Contributing
Contributions are welcome! Feel free to open issues or submit pull requests.
## License
Secured is distributed under the MIT License. See `LICENSE` for more information.
```