# stegify

**Repository Path**: excelsi0r/stegify

## Basic Information

- **Project Name**: stegify
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2019-01-16
- **Last Updated**: 2020-12-18

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# stegify
[![GoDoc](https://godoc.org/github.com/DimitarPetrov/stegify?status.svg)](https://godoc.org/github.com/DimitarPetrov/stegify)
[![Go Report Card](https://goreportcard.com/badge/github.com/DimitarPetrov/stegify)](https://goreportcard.com/report/github.com/DimitarPetrov/stegify)
[![cover.run](https://cover.run/go/github.com/DimitarPetrov/stegify.svg?style=flat&tag=golang-1.10)](https://cover.run/go?tag=golang-1.10&repo=github.com%2FDimitarPetrov%2Fstegify)
[![Mentioned in Awesome Go](https://awesome.re/mentioned-badge.svg)](https://github.com/avelino/awesome-go)  


## Overview
`stegify` is a simple command line tool that is capable of fully transparent hiding files within an image.
The technique is known as [steganography](https://en.wikipedia.org/wiki/steganography). This tool uses
the technique known as LSB (Least Significant Bit) Steganography. 

## Demonstration

| Carrier                                | Data                                | Result                                               |
| ---------------------------------------| ------------------------------------|------------------------------------------------------|
| ![Original File](examples/street.jpeg) | ![Encoded File](examples/lake.jpeg) | ![Encoded File](examples/test_decode.jpeg) |

The `Result` file contains the `Data` file hidden in it. And as you can see it is fully transparent.

## Install
```
$ go get github.com/DimitarPetrov/stegify
```

## Usage

```
$ stegify -op encode -carrier <file-name> -data <file-name> -result <file-name>
$ stegify -op decode -carrier <file-name> -result <file-name>
```
When encoding, the file with name given to flag `-data` is hidden inside the file with name given to flag
`-carrier` and the resulting file is saved in new file in the current working directory under the
name given to flag `-result`. The file extension of result file is inherited from the carrier file and must not be specified
explicitly in the `-result` flag.

When decoding, given a file name of a carrier file with previously encoded data in it, the data is extracted
and saved in new file in the current working directory under the name given to flag `-result`.
The result file won't have any file extension and therefore it should be specified explicitly in `-result` flag.

In both cases the flag `-result` could be omitted and it will be used the default file name: `result`

## Disclaimer

If carrier file is in jpeg or jpg format, after encoding the result file image will be png encoded (therefore it may be bigger in size)
despite of file extension inherited from the original carrier file (which is .jpeg or .jpg).