Stegano - GitLite

KO | EN

gitlite — search

#javascript #python #hacktoberfest #go #android #deep-learning #nodejs #macos #cli #vue #awesome-list #security #pytorch #ios

Stegano

(★ 594)

A pure Python steganography module.

File Explorer

Download Latest Version (.zip)

- - pythonapp.yaml
  - release.yml
- conf.py
- index.rst
- installation.rst
- make.bat
- Makefile
- module.rst
- requirements.txt
- software.rst
- steganalysis.rst
- - __init__.py
  - exifHeader.py
  - lsb.py
  - parity.py
  - rdh.py
  - red.py
  - statistics.py
  - wav.py
- - __init__.py
  - exifHeader.py
- - __init__.py
  - generators.py
  - lsb.py
- - __init__.py
  - histogram_shifting.py
- - __init__.py
  - red.py
- - __init__.py
  - parity.py
  - statistics.py
- - __init__.py
  - wav.py
- __init__.py
- tools.py
- - ackermann
  - binary2base64
  - carmichael
  - composite
  - eratosthenes
  - fermat
  - LFSR
  - mersenne
  - parity.png
  - parity_rgba.png
  - shi_tomashi.txt
  - statistics
  - triangular_numbers
- - 20160505T130442.jpg
  - free-software-song.ogg
  - free-software-song.wav
  - Lenna-grayscale.png
  - Lenna.jpg
  - Lenna.png
  - lorem_ipsum.txt
  - Montenach.png
  - transparent.png
- __init__.py
- test_exifHeader.py
- test_generators.py
- test_lsb.py
- test_rdh.py
- test_red.py
- test_steganalysis.py
- test_tools.py
- test_wav.py
.editorconfig
.gitignore
.pre-commit-config.yaml
.readthedocs.yaml
benchmark_performance.py
CHANGELOG.md
CLAUDE.md
CONTRIBUTORS.md
COPYING
poetry.lock
pyproject.toml
README.md

# Installation Guide

1. Get the code

git clone https://github.com/cedricbonhomme/Stegano

Downloads the entire project code from GitHub to your computer.

cd Stegano

Moves into the project folder you just downloaded.

2. Python

Easy Recommended

Prerequisites

Git Needed to download the project code from GitHub.
Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.

$ poetry install stegano

Installs the libraries listed in pyproject.toml.

$ python -m unittest discover -v

Runs the Python script (or module).

✅ If it runs without errors and prints output in the terminal, it worked.

Pulled directly from this repo's README.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Stegano

[![Workflow](https://github.com/cedricbonhomme/Stegano/workflows/Python%20application/badge.svg?style=flat-square)](https://github.com/cedricbonhomme/Stegano/actions?query=workflow%3A%22Python+application%22)

[Stegano](https://github.com/cedricbonhomme/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

```bash
$ 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:

```bash
$ 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](https://stegano.readthedocs.io) 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:

```python
>>> 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")
```

For *reversible* data hiding (the original cover can be restored exactly after
the message is extracted), use the histogram-shifting technique:

```python
>>> from stegano import rdh
>>> secret = rdh.hide("./tests/sample-files/Lenna-grayscale.png", "Hello World")
>>> secret.save("./Lenna-secret.png")
>>>
>>> clear_message = rdh.reveal("./Lenna-secret.png")
>>> cover = rdh.recover("./Lenna-secret.png")  # restores the original image
```

## Use Stegano as a command line tool

### Hide and reveal a message

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

### Reversibly hide a message and recover the cover

```bash
$ stegano-rdh hide -i ./tests/sample-files/Lenna-grayscale.png -m "Secret Message" -o stego.png
$ stegano-rdh reveal -i stego.png
Secret Message
$ stegano-rdh recover -i stego.png -o cover.png   # cover.png == the original image
```

### Hide the message with the Sieve of Eratosthenes

```bash
$ 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

```bash
$ python -m unittest discover -v
```

Running the static type checker:

```bash
$ 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](https://img.shields.io/github/sponsors/cedricbonhomme)](https://github.com/sponsors/cedricbonhomme)

or with Bitcoin to this address:  
bc1q56u6sj7cvlwu58v5lemljcvkh7v2gc3tv8mj0e

Thank you !

## License

This software is licensed under
[GNU General Public License version 3](https://www.gnu.org/licenses/gpl-3.0.html)

Copyright (C) 2010-2026 [Cédric Bonhomme](https://www.cedricbonhomme.org)

For more information, [the list of authors and contributors](CONTRIBUTORS.md) is available.