- License: MIT
- Documentation: https://DAI-Lab.github.io/SteganoGAN
- Homepage: https://github.com/DAI-Lab/SteganoGAN
SteganoGAN is a tool for creating steganographic images using adversarial training.
To get started with SteganoGAN, we recommend using pip:
pip install steganoganAlternatively, you can clone the repository and install it from source by running make install:
git clone [email protected]:DAI-Lab/SteganoGAN.git
cd SteganoGAN
make installFor 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.
SteganoGAN includes a simple command line interface for encoding and decoding steganographic images.
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"
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
The script has some additional options to control its behavior:
-o, --output PATH: Path where the generated image will be stored. Defaults tooutput.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.
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(architecture='dense')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!')
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!'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.
For more details about SteganoGAN and all its possibilities and features, please check the project documentation site!
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}
}