Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/revelaction/stegage
stegage is a command line tool and Go library to both encrypt (with age) and conceal (with steganography) a file.
https://github.com/revelaction/stegage
age age-encryption encryption go golang steganography
Last synced: 14 days ago
JSON representation
stegage is a command line tool and Go library to both encrypt (with age) and conceal (with steganography) a file.
- Host: GitHub
- URL: https://github.com/revelaction/stegage
- Owner: revelaction
- License: mit
- Created: 2021-12-27T23:25:00.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-09-23T20:26:14.000Z (4 months ago)
- Last Synced: 2024-11-19T13:46:13.216Z (3 months ago)
- Topics: age, age-encryption, encryption, go, golang, steganography
- Language: Go
- Homepage: https://pkg.go.dev/github.com/revelaction/privage
- Size: 448 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Authors: AUTHORS
Awesome Lists containing this project
README
[](https://pkg.go.dev/github.com/revelaction/stegage)
[](https://github.com/revelaction/stegage/actions/workflows/test.yml)
[](https://github.com/revelaction/stegage/actions/workflows/build.yml)
[](https://goreportcard.com/report/github.com/revelaction/stegage)
[]()
[]()
**stegage** is a command line tool and Go library to both encrypt
(with [age](https://github.com/FiloSottile/age)) and conceal
(with [steganography](https://github.com/auyer/steganography)) a file.
| Original image |Encoded image with the encrypted file inside |
| -------------------- | ------------------|
|  | 
## How it works
### encode
**stegage** encrypts a file (f.ex. `doc.txt`) with a passphrase and embeds the
encrypted file inside an image (f.ex. `stegage.jpeg`. The resulting image `stegage_encoded.png` is
visually identical to the original image `stegage.jpeg`.
┌────────────┐ ┌────────────┐
│ doc.txt │ encrypt │ doc.txt.enc│
│ ├─────────────►│ ├────┐
│ │ │ │ │ ┌─────────────────────────────────┐
│ │ │ │ │ │ stegage_encoded.png│
└────────────┘ └────────────┘ │ stegano │ │
│ graphy │ │
┌─────────────────────────────────┐ ├─────────►│ ┌────────────┐ │
│ stegage.jpeg │ │ │ │ doc.txt.enc│ │
│ │ │ │ │ │ │
│ │ │ │ │ │ │
│ │ │ │ │ │ │
│ │ │ │ └────────────┘ │
│ ├─┘ │ │
│ │ └─────────────────────────────────┘
│ │
│ │
│ │
└─────────────────────────────────┘
The supported image formats for embedding are `jpeg` and `png`. The resulting image format is always `png`.
### decode
**stegage** extracts the encrypted file from the embedding image and decrypts it.
┌─────────────────────────────────┐
│ stegage_encoded.png│
│ │ ┌────────────┐ ┌────────────┐
│ │ │ doc.txt.enc│ │ doc.txt │
│ ┌────────────┐ │ steganography │ │ decrypt │ │
│ │ doc.txt.enc│ ├────────────────►│ ├───────────►│ │
│ │ │ │ │ │ │ │
│ │ │ │ └────────────┘ └────────────┘
│ │ │ │
│ └────────────┘ │
│ │
└─────────────────────────────────┘
## Usage
### encode
Encrypt the file `doc.txt` and embed the encrypted payload in a copy of
`stegage.png`. Save the copy to the file `stegage_encoded.png`.
```bash
⤷ stegage encode --inside stegage.png doc.txt > stegage_encoded.png
Enter passphrase:
Confirm passphrase:
```
### decode
Extract the encrypted payload from the file `stegage_encoded.png` and decrypt
it. Save the decrypted payload to the file `doc.txt`
```console
⤷ stegage decode stegage_encoded.png > doc.txt
Enter passphrase:
```
## Installation
### Official binary Releases
You can download the latest release versions of stegage from the [stegage
release page.](https://github.com/revelaction/stegage/releases/)
### Build from source
If your system has Go 1.17+:
```console
go install github.com/revelaction/stegage/[email protected]
```
## Library Usage
### encode
```go
// error handling omitted for brevity. See ./cmd/stegage/main.go for a real example
image, _ := os.Open(image.png)
passphrase:= strings.NewReader("aj4@7%8821vja")
data, _ := os.Open("doc.txt")
out, _ := os.Create("encoded.png")
err := stegage.Encode(passphrase, data, image, out); err != nil {
fmt.Printf("stegage: error encoding: %v", err)
}
```
### decode
```go
imageEncoded, _ := os.Open(image_encoded.png)
passphrase := strings.NewReader("aj4@7%8821vja")
out, _ := os.Create("doc.txt")
err := stegage.Decode(passphrase, imageEncoded, out); err != nil {
fmt.Printf("stegage: error decoding: %v", err)
}
```
## Bash Completion
`stegage` has builtin bash autocompletion. You can enable it by putting the following bash
snippet in your `.bashrc` file:
```console
if hash stegage; then
PROG=stegage source <(stegage bash)
fi
```
## Command line options
```console
⤷ stegage help
NAME:
stegage - encrypt and conceal (steganography) a file
USAGE:
stegage [global options] command [command options] [arguments...]
COMMANDS:
encode, e Encrypt a file with age and additionally conceal with steganography
decode, d Decrypt an age encrypted file inside of an image file
bash Dump bash complete script
help, h Shows a list of commands or help for one command
GLOBAL OPTIONS:
--help, -h show help (default: false)
```