Skip to content
SteganoGAN is a tool for creating steganographic images using adversarial training.
Branch: master
Clone or download
Latest commit f67d235 May 28, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Update ISSUE_TEMPLATE.md May 15, 2019
docs Clean dependencies and changed github repository name and url to be p… Jan 16, 2019
research Fix lint to work as expected, also fixed lints in research/train.py a… Jan 16, 2019
steganogan Bump version: 0.1.2 → 0.1.3-dev Feb 5, 2019
tests Allowing path loading from the cli.py Feb 1, 2019
.gitignore
.travis.yml Clean dependencies and changed github repository name and url to be p… Jan 16, 2019
AUTHORS.rst Update AUTHORS.rst Jan 15, 2019
CONTRIBUTING.rst Clean dependencies and changed github repository name and url to be p… Jan 16, 2019
HISTORY.md Release notes for v0.1.2 Feb 5, 2019
LICENSE Renamed project to SteganoGAN. Dec 4, 2018
MANIFEST.in Finish the CLI and update the README instructions Dec 22, 2018
Makefile Addressed feedback Jan 3, 2019
README.md
setup.cfg Bump version: 0.1.2 → 0.1.3-dev Feb 5, 2019
setup.py Locked torch requierement to 1.0.0 May 16, 2019
tox.ini Fix lint to work as expected, also fixed lints in research/train.py a… Jan 16, 2019

README.md

SteganoGAN An open source project from Data to AI Lab at MIT.

PyPI Shield Travis CI Shield

SteganoGAN

Overview

SteganoGAN is a tool for creating steganographic images using adversarial training.

Installation

To get started with SteganoGAN, we recommend using pip:

pip install steganogan

Alternatively, you can clone the repository and install it from source by running make install:

git clone git@github.com:DAI-Lab/SteganoGAN.git
cd SteganoGAN
make install

For development, you can use the make install-develop command instead in order to install all the required dependencies for testing and linting.

NOTE SteganoGAN currently requires torch version to be 1.0.0 in order to work properly.

Usage

Command Line

SteganoGAN includes a simple command line interface for encoding and decoding steganographic images.

Hide a message inside an image

To create a steganographic image, you simply need to supply the path to the cover image and the secret message:

steganogan encode [options] path/to/cover/image.png "Message to hide"

Read a message from an image

To recover the secret message from a steganographic image, you simply supply the path to the steganographic image that was generated by a compatible model:

steganogan decode [options] path/to/generated/image.png

Additional options

The script has some additional options to control its behavior:

  • -o, --output PATH: Path where the generated image will be stored. Defaults to output.png.
  • -a, --architecture ARCH: Architecture to use, basic or dense. Defaults to dense.
  • -v, --verbose: Be verbose.
  • --cpu: force CPU usage even if CUDA is available. This might be needed if there is a GPU available in the system but the VRAM amount is too low.

WARNING: Make sure to use the same architecture specification (--architecture) during both the encoding and decoding stage; otherwise, SteganoGAN will fail to decode the message.

Python

The primary way to interact with SteganoGAN from Python is through the steganogan.SteganoGAN class. This class can be instantiated using a pretrained model:

>>> from steganogan import SteganoGAN
>>> steganogan = SteganoGAN.load('steganogan/pretrained/dense.steg')
Using CUDA device

Once we have loaded our model, we can give it the input image path, the output image path, and the secret message:

>>> steganogan.encode('research/input.png', 'research/output.png', 'This is a super secret message!')
Encoding completed.

This will generate an output.png image that closely resembles the input image but contains the secret message. In order to recover the message, we can simply pass output.png to the decode method:

>>> steganogan.decode('research/output.png')
'This is a super secret message!'

Research

We provide example scripts in the research folder which demonstrate how you can train your own SteganoGAN models from scratch on arbitrary datasets. In addition, we provide a convenience script in research/data for downloading two popular image datasets.

References

If you use SteganoGAN for your research, please consider citing the following work:

Zhang, Kevin Alex and Cuesta-Infante, Alfredo and Veeramachaneni, Kalyan. SteganoGAN: High Capacity Image Steganography with GANs. MIT EECS, January 2019. (PDF)

@article{zhang2019steganogan,
  title={SteganoGAN: High Capacity Image Steganography with GANs},
  author={Zhang, Kevin Alex and Cuesta-Infante, Alfredo and Veeramachaneni, Kalyan},
  journal={arXiv preprint arXiv:1901.03892},
  year={2019},
  url={https://arxiv.org/abs/1901.03892}
}
You can’t perform that action at this time.