Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/charles-m-knox/steganographics
A CLI tool and library to enable easy access to steganography.
https://github.com/charles-m-knox/steganographics
cli go golang server steganography
Last synced: 10 days ago
JSON representation
A CLI tool and library to enable easy access to steganography.
- Host: GitHub
- URL: https://github.com/charles-m-knox/steganographics
- Owner: charles-m-knox
- License: agpl-3.0
- Created: 2024-09-09T22:14:00.000Z (2 months ago)
- Default Branch: main
- Last Pushed: 2024-09-09T22:34:53.000Z (2 months ago)
- Last Synced: 2024-09-10T03:05:37.980Z (2 months ago)
- Topics: cli, go, golang, server, steganography
- Language: Go
- Homepage:
- Size: 541 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# steganographics
A tool to enable easy access to steganography by embedding secret text in PNG images.
It uses a simple Least Significant Bit (LSB) algorithm to distribute the desired secret bytes across the first bytes in the red channel of an image.
## Usage
This program has three modes of operation - in all three modes, this project has no dependencies, it just uses standard library:
- as a Go library that you can import
- command line tool
- a standalone HTTP server
### Go library
This Go library has no dependencies aside from the standard library, and will work with `CGO_ENABLED=0`.
```bash
go get -v github.com/charles-m-knox/steganographics/pkg/steganographics
```
Usage:
```go
package main
import (
s "github.com/charles-m-knox/steganographics/pkg/steganographics"
)
func getTextFromStdin() {
img, _, err := image.Decode(os.Stdin)
if err != nil {
log.Fatalf("failed to read img from stdin: %v", err.Error())
}
os.Stdout.Write(s.ExtractTextFromImage(img))
}
func writeTextToImageFromStdin(hiddenText string) {
img, _, err := image.Decode(os.Stdin)
if err != nil {
log.Fatalf("failed to read img from stdin: %v", err.Error())
}
output, err := s.HideTextInImage(img, []byte(hiddenText))
if err != nil {
log.Fatalf("failed to read img from stdin: %v", err.Error())
}
err = png.Encode(os.Stdout, output)
if err != nil {
log.Fatalf("failed to write img to stdout: %v", err.Error())
}
}
```
### Command line tool
If you want to use Go's `go install` to install steganographics, you can do it by trimming the `pkg/steganographics` suffix from the earlier `go get` command:
```bash
go install github.com/charles-m-knox/steganographics
```
Once installed, `steganographics` supports piping from `stdin` and to `stdout`:
```bash
# writes secret text to an image, and then immediately echoes the secret
# text from it
cat path/to/image.png | ./steganographics -secret "secret message1" | ./steganographics
```
It can also directly read and write to/from files:
```bash
# write a message into an image:
./steganographics -input path/to/image.png -output path/to/output.png -secret "secret message2"
# read a message from an image:
./steganographics -input path/to/image.png
```
### HTTP server API
```bash
./steganographics -addr "0.0.0.0:29104"
# with tls:
make gen-tls-certs # optional - generates certs and requires interactive input
./steganographics -addr "0.0.0.0:29104" -cert cert.pem -key key.pem
```
When running as an HTTP server, this program provides two REST API endpoints:
1. `/api/hide`: Accepts a POST request with a JSON payload containing a `msg` field with the text to hide, and a `png` field with the Base64-encoded PNG image data. The endpoint hides the text in the image using the LSB technique and returns the modified PNG image.
2. `/api/extract`: Accepts a POST request with a JSON payload containing a `png` field with the Base64-encoded PNG image data. The endpoint extracts the hidden text from the image using the LSB technique and returns a JSON response with the extracted text in a `msg` field.
To test the endpoints, you can use an HTTP client like `curl` or a tool like Postman to send POST requests with the appropriate JSON payload to the `/api/hide` and `/api/extract` endpoints.
## Disclaimers and warnings
- This may not be the most secure/private/hardened method of encoding text in an image.
- This is a side project and may have bugs or other issues.
- This project is licensed AGPL3 so you cannot use it unless you abide by the license terms.
- Unit tests are not currently implemented, but the library does work as expected in intended, normal use cases.
- This library may alter your source image in more ways than simply the LSB algorithm.
- Compression or other image alterations run the risk of wiping out the embedded image.
## Appendix
This is a useful command using ImageMagick's `convert` command line tool to convert a jpg to png:
```bash
# note: as of imagemagick v7, it might now called "magick" instead of "convert"
# on your system
convert -quality 100 -define png:compression-level=9 input.jpg input.png
```