Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/auyer/steganography
Pure Golang Library that allows LSB steganography on images using ZERO dependencies
https://github.com/auyer/steganography
go golang golang-library image image-processing library steganography zero-dependency
Last synced: about 2 months ago
JSON representation
Pure Golang Library that allows LSB steganography on images using ZERO dependencies
- Host: GitHub
- URL: https://github.com/auyer/steganography
- Owner: auyer
- License: mit
- Created: 2018-05-21T17:27:36.000Z (over 6 years ago)
- Default Branch: main
- Last Pushed: 2024-05-19T20:08:22.000Z (7 months ago)
- Last Synced: 2024-07-31T20:52:02.098Z (5 months ago)
- Topics: go, golang, golang-library, image, image-processing, library, steganography, zero-dependency
- Language: Go
- Homepage:
- Size: 2.25 MB
- Stars: 306
- Watchers: 10
- Forks: 43
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-go - steganography - Pure Go Library for LSB steganography. (Images / Search and Analytic Databases)
- zero - steganography
- awesome-list - steganography
- awesome-go - steganography - Pure Golang Library that allows simple LSB steganography on images - ★ 10 (Images)
- awesome-go-extra - steganography - 05-21T17:27:36Z|2021-07-29T15:48:34Z| (Images / Advanced Console UIs)
- awesome-go-zh - steganography
README
# Steganography Lib
[](http://godoc.org/github.com/auyer/steganography)
[](https://goreportcard.com/report/github.com/auyer/steganography)
[](https://img.shields.io/badge/license-MIT-brightgreen.svg)
[](https://github.com/auyer/steganography/actions)
[](https://codecov.io/gh/auyer/steganography)
[](https://github.com/avelino/awesome-go)
Steganography is a library written in Pure go to allow simple LSB steganography on images. It is capable of both encoding and decoding images. It can store files of any format.
This library is inspired by [Stego by EthanWelsh](https://github.com/EthanWelsh/Stego), a command line utility with the same purpose.
## Installation
```go
go get -u github.com/auyer/steganography
```
## Demonstration
| Original |Encoded |
| -------------------- | ------------------|
|  | 
The second image contains the first paragraph of the description of a stegosaurus on [Wikipedia](https://en.wikipedia.org/wiki/Stegosaurus), also available in [examples/message.txt](https://raw.githubusercontent.com/auyer/steganography/master/examples/message.txt) as an example.
------
Getting Started
------
```go
package main
import (
"bufio"
"image/png"
"io/ioutil"
"github.com/auyer/steganography"
)
```
Encode
------
Write mode is used to take a message and embed it into an image file using LSB steganography in order to produce a secret image file that will contain your message.
Note that the minimum image size is 24 pixels for one byte. For each additional byte, it is necessary 3 more pixels.
```go
inFile, _ := os.Open("input_file.png") // opening file
reader := bufio.NewReader(inFile) // buffer reader
img, _ := png.Decode(reader) // decoding to golang's image.Image
w := new(bytes.Buffer) // buffer that will recieve the results
err := steganography.Encode(w, img, []byte("message")) // Encode the message into the image
if err != nil {
log.Printf("Error Encoding file %v", err)
return
}
outFile, _ := os.Create("out_file.png") // create file
w.WriteTo(outFile) // write buffer to it
outFile.Close()
```
note: all error checks were removed for brevity, but they should be included.
Size of Message
------
Length mode can be used in order to preform a preliminary check on the carrier image in order to deduce how large of a file it can store.
```go
sizeOfMessage := steganography.GetMessageSizeFromImage(img) // retrieves the size of the encoded message
```
Decode
-----
Read mode is used to read an image that has been encoded using LSB steganography, and extract the hidden message from that image.
```go
inFile, _ := os.Open(encodedInputFile) // opening file
defer inFile.Close()
reader := bufio.NewReader(inFile) // buffer reader
img, _ := png.Decode(reader) // decoding to golang's image.Image
sizeOfMessage := steganography.GetMessageSizeFromImage(img) // retrieving message size to decode in the next line
msg := steganography.Decode(sizeOfMessage, img) // decoding the message from the file
fmt.Println(string(msg))
```
note: all error checks were removed for brevity, but they should be included.
Complete Example
------
For a complete example, see the [examples/stego.go](examples/stego.go) file. It is a command line app based on the original fork of this repository, but modified to use the Steganography library.
-----
### Attributions
- Stegosaurus Picture By Matt Martyniuk - Own work, CC BY-SA 3.0, https://commons.wikimedia.org/w/index.php?curid=42215661