Skip to main content

Steganography tool based on DeepLearning GANs

Project description

“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.

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}
}

History

0.1.2

  • Add option to work with a custom pretrained model from CLI and Python
  • Refactorize Critics and Decoders to match Encoders code style
  • Make old pretrained models compatible with new code versions
  • Cleanup unneeded dependencies
  • Extensive unit testing

0.1.1

  • Add better pretrained models.
  • Improve support for non CUDA devices.

0.1.0 - First release to PyPi

  • SteganoGAN class which can be fitted, saved, loaded and used to encode and decode messages.
  • Basic command line interface that allow using pretrained models.
  • Basic and Dense pretrained models for demo purposes.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for steganogan, version 0.1.2
Filename, size File type Python version Upload date Hashes
Filename, size steganogan-0.1.2-py2.py3-none-any.whl (2.8 MB) File type Wheel Python version py2.py3 Upload date Hashes View
Filename, size steganogan-0.1.2.tar.gz (4.4 MB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page