Stegano/docs/index.rst

75 lines
2.2 KiB
ReStructuredText

.. Stéganô documentation master file, created by
sphinx-quickstart on Wed Jul 25 13:33:39 2012.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to Stéganô's documentation!
===================================
Presentation
============
.. figure:: https://api.travis-ci.org/cedricbonhomme/Stegano.svg?branch=master
:align: left
:target: https://travis-ci.org/cedricbonhomme/Stegano
Stéganô_ is a 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 Stéganô only hide message,
without encryption. Indeed steganography is often used with cryptography.
Requirements
============
- Python_ >= 3.2 (tested with Python 3.3.1);
- `Pillow`_.
Methods of hiding
=================
For the moment, Stéganô implements these methods of hiding:
- using the red portion of a pixel to hide ASCII messages;
- using the `Least Significant Bit <http://en.wikipedia.org/wiki/Least_significant_bit>`_ (LSB) technique;
- using the LSB technique with sets based on generators (Sieve for Eratosthenes, Fermat, Mersenne numbers, etc.);
- using the description field of the image (JPEG).
Moreover some methods of steganalysis_ are provided:
- steganalysis of LSB encoding in color images;
- statistical steganalysis.
Turorial
========
More information available at the :doc:`tutorial </tutorial>` page
License
=======
Stéganô_ is under GPL v3 license.
Donation
========
If you wish and if you like Stéganô, you can donate via bitcoin. My bitcoin address: `1GVmhR9fbBeEh7rP1qNq76jWArDdDQ3otZ <http://blockexplorer.com/address/1GVmhR9fbBeEh7rP1qNq76jWArDdDQ3otZ>`_
Contact
=======
`My home page <https://www.cedricbonhomme.org>`_
.. _Python: http://python.org
.. _Stéganô: https://github.com/cedricbonhomme/Stegano
.. _`Pillow`: https://pypi.python.org/pypi/Pillow
.. _steganography: http://en.wikipedia.org/wiki/Steganography
.. _steganalysis: http://en.wikipedia.org/wiki/Steganalysis