# 🕵️♂️ Stegano
[](https://crates.io/crates/stegano)
[](https://crates.io/crates/stegano)
[](https://opensource.org/licenses/MIT)
> 🚀 `stegano`: Stegano is a powerful and versatile steganography tool designed to empower you with a wide range of image manipulation and data encryption capabilities.
## 📖 Table of Contents
- [Installation](#-installation)
- [Usage](#-usage)
- [Options](#-options)
- [Contributing](#-contributing)
- [License](#-license)
## 🚀 Installation
To install `stegano`, use the following Cargo command:
```bash
cargo install --locked stegano
```
## 🛠️ Usage
`stegano` provides three subcommands:
```bash
$ stegano -h
The ultimate steganography swiss knife army tool.
Usage: stegano [COMMAND]
Commands:
encrypt Subcommand for encryption
decrypt Subcommand for decryption
show-meta Subcommand for showing metadata
help Print this message or the help of the given subcommand(s)
Options:
-h, --help Print help
-V, --version Print version
```
Use these subcommands to process and manipulate png images. Here are some examples:
1. Read and process 10 chunks from the image:
```bash
$ stegano show-meta -i image_file_name
It is a valid PNG file. Let's process it!
---- Chunk #1 ----
Chunk offset: 13
Chunk size: 0
Chunk crc: 3d008
---- Chunk #2 ----
Chunk offset: 30
Chunk size: 0
Chunk crc: 52474200
---- Chunk #3 ----
Chunk offset: 47
Chunk size: 73
Chunk crc: 333db36f
---- Chunk #4 ----
Chunk offset: 137
Chunk size: 91
Chunk crc: 4000023e
---- Chunk #5 ----
Chunk offset: 245
Chunk size: 251
Chunk crc: 21080
---- Chunk #6 ----
Chunk offset: 513
Chunk size: 108
Chunk crc: 10021080
---- Chunk #7 ----
Chunk offset: 638
Chunk size: 2
Chunk crc: 35025ded
---- Chunk #8 ----
Chunk offset: 657
Chunk size: 3
Chunk crc: 25b3f696
---- Chunk #9 ----
Chunk offset: 677
Chunk size: 57
Chunk crc: 80000420
---- Chunk #10 ----
Chunk offset: 751
Chunk size: 64
Chunk crc: 91cf0867
```
1. Process the image in silent mode:
```bash
$ stegano show-meta -i image_file_name -s
```
1. Read chunks at different positions:
```bash
$ stegano show-meta -i image_file_name -c 0 -u 10 -n 1
It is a valid PNG file. Let's process it!
---- Chunk #0 ----
Chunk offset: 13
Chunk size: 0
Chunk crc: 3d008
# Read 3 chunks starting from position 10000
$ stegano show-meta -i image_file_name -c 10000 -u 200000 -n 3
It is a valid PNG file. Let's process it!
---- Chunk Chunk offset: 13
Chunk size: 0
Chunk crc: 3d008
---- Chunk Chunk offset: 30
Chunk size: 0
Chunk crc: 52474200
---- Chunk Chunk offset: 47
Chunk size: 73
Chunk crc: 333db36f
```
1. Encrypt an inject data in an image:
```bash
$ stegano encrypt -i input_image_file_name -k 'pass' -p 'hello' -f 159028 -o output_image_file_name -s
It is a valid PNG file. Let's process it!
Image encoded and written successfully!
```
1. Decrypt, extract secrets from an image and remove the secret from the image:
```bash
$ stegano decrypt -i input_image_file_name -k 'pass' -f 159028 -o output_image_file_name -s
Your decoded secret is: "hello"
```
## 🎨 Options
| **Encryption Options** | |
| `-i` or `--input` | Sets the input file for encryption. |
| `-o` or `--output` | Sets the output file for the encrypted payload (default is "output.png").|
| `-k` or `--key` | Sets the key for payload encryption (default is "key"). |
| `-s` or `--suppress` | Suppresses output messages. |
| `-f` or `--offset` | Sets the offset (default is 10). |
| `-p` or `--payload` | Sets the payload (default is "hello"). |
| `-t` or `--type` | Sets the type (default is "PNG"). |
| | |
| **Decryption Options** | |
| `-i` or `--input` | Sets the input file for decryption. |
| `-o` or `--output` | Sets the output file for the decrypted payload (default is "output.png").|
| `-k` or `--key` | Sets the key for payload decryption (default is "key"). |
| `-s` or `--suppress` | Suppresses output messages. |
| `-f` or `--offset` | Sets the offset (default is 10). |
| `-p` or `--payload` | Sets the payload (default is "hello"). |
| `-t` or `--type` | Sets the type (default is "PNG"). |
| | |
| **Metadata Options** | |
| `-i` or `--input` | Sets the input image file for metadata extraction. |
| `-n` or `--nb-chunks` | Read a specific number of chunks (default is 10). |
| `-c` or `--start` | Sets the index of the start chunk to read from (default 1). |
| `-u` or `--end` | Sets the index of the end chunk to stop reading at (default 11).|
| `-s` or `--suppress` | Suppresses output messages. |
## 🤝 Contributing
Contributions and feedback are welcome! If you'd like to contribute, report an issue, or suggest an enhancement, please engage with the project on [GitHub](https://github.com/wiseaidev/stegano).
Your contributions help improve this crate for the community.
## 📄 License
This project is licensed under the [MIT License](https://opensource.org/licenses/MIT).