A pure Python steganography module.
Find a file
Cédric Bonhomme eb28c60d27
Some checks failed
Python application / build (3.10) (push) Has been cancelled
Python application / build (3.11) (push) Has been cancelled
Python application / build (3.12) (push) Has been cancelled
chg: [RELEASE] Bumped version number, improved packaging for the command line.
2025-05-03 23:15:52 +02:00
.github/workflows chg: [RELEASE] Bumped version number and aligned pyproject.toml file with standard specification. 2025-02-13 18:14:40 +01:00
docs chg: [RELEASE] Updated documentation, updated dependencies, and bumped version number. 2025-04-26 23:28:17 +02:00
stegano chg: [RELEASE] Bumped version number, improved packaging for the command line. 2025-05-03 23:15:52 +02:00
tests chg: Updated copyright years. 2025-01-03 13:17:58 +01:00
.editorconfig new: added .editorconfig 2021-11-01 13:51:47 +01:00
.gitignore Updated .gitignore. 2020-08-20 09:56:34 +02:00
.pre-commit-config.yaml chg: Updated README. 2024-10-05 16:47:41 +02:00
.readthedocs.yaml Moved the requirements file dedicated to the documentation. 2023-12-31 00:45:28 +01:00
CHANGELOG.md chg: [RELEASE] Bumped version number, improved packaging for the command line. 2025-05-03 23:15:52 +02:00
CONTRIBUTORS.md chg: Updated copyright years. 2025-01-03 13:17:58 +01:00
COPYING Dropped Python 3.8 support. 2023-12-31 00:38:32 +01:00
poetry.lock chg: [RELEASE] Bumped version number, improved packaging for the command line. 2025-05-03 23:15:52 +02:00
pyproject.toml chg: [RELEASE] Bumped version number, improved packaging for the command line. 2025-05-03 23:15:52 +02:00
README.md chg: [RELEASE] Bumped version number and aligned pyproject.toml file with standard specification. 2025-02-13 18:14:40 +01:00

Stegano

Workflow

Stegano, a pure Python Steganography module.

Steganography is the art and science of writing hidden messages in such a way that no one, apart from the sender and intended recipient, suspects the existence of the message, a form of security through obscurity. Consequently, functions provided by Stegano only hide messages, without encryption. Steganography is often used with cryptography.

Installation

$ poetry install stegano

You will be able to use Stegano in your Python programs.

If you only want to install Stegano as a command line tool:

$ pipx install stegano

pipx installs scripts (system wide available) provided by Python packages into separate virtualenvs to shield them from your system and each other.

Usage

A tutorial is available.

Use Stegano as a library in your Python program

If you want to use Stegano in your Python program you just have to import the appropriate steganography technique. For example:

>>> from stegano import lsb
>>> secret = lsb.hide("./tests/sample-files/Lenna.png", "Hello World")
>>> secret.save("./Lenna-secret.png")
>>>
>>> clear_message = lsb.reveal("./Lenna-secret.png")

Use Stegano as a command line tool

Hide and reveal a message

$ stegano-lsb hide -i ./tests/sample-files/Lenna.png -m "Secret Message" -o Lena1.png
$ stegano-lsb reveal -i Lena1.png
Secret Message

Hide the message with the Sieve of Eratosthenes

$ stegano-lsb hide -i ./tests/sample-files/Lenna.png -m 'Secret Message' --generator eratosthenes -o Lena2.png

The message will be scattered in the picture, following a set described by the Sieve of Eratosthenes. Other sets are available. You can also use your own generators.

This will make a steganalysis more complicated.

Running the tests

$ python -m unittest discover -v

Running the static type checker:

$ mypy stegano

Contributions

Contributions are welcome. If you want to contribute to Stegano I highly recommend you to install it in a Python virtual environment with poetry.

Donations

If you wish and if you like Stegano, you can donate via GitHub Sponsors:

GitHub Sponsors

or with Bitcoin to this address:
bc1q56u6sj7cvlwu58v5lemljcvkh7v2gc3tv8mj0e

Thank you !

License

This software is licensed under GNU General Public License version 3

Copyright (C) 2010-2025 Cédric Bonhomme

For more information, the list of authors and contributors is available.