mirror of
https://github.com/cedricbonhomme/Stegano.git
synced 2025-05-12 00:58:32 +02:00
Updated documentation appropriately.
This commit is contained in:
Cédric Bonhomme
parent
0d1c5cc4c1
commit
46ee52f8e1
5 changed files with 54 additions and 44 deletions
|
|
@ -1,6 +1,11 @@
|
|||
Release History
|
||||
===============
|
||||
|
||||
0.6 (not yet released)
|
||||
------------------
|
||||
|
||||
* improvements of the command line of Stéganô.
|
||||
|
||||
0.5.5 (2016-08-03)
|
||||
------------------
|
||||
|
||||
|
|
|
|||
|
|
@ -48,9 +48,9 @@ copyright = u'2012-2016, Cédric Bonhomme'
|
|||
# built documents.
|
||||
#
|
||||
# The short X.Y version.
|
||||
version = '0.5'
|
||||
version = '0.6'
|
||||
# The full version, including alpha/beta/rc tags.
|
||||
release = '0.5.4'
|
||||
release = '0.6'
|
||||
|
||||
# The language for content autogenerated by Sphinx. Refer to documentation
|
||||
# for a list of supported languages.
|
||||
|
|
|
|||
|
|
@ -6,34 +6,43 @@ Display help
|
|||
|
||||
.. code-block:: bash
|
||||
|
||||
$ slsb --help
|
||||
Usage: slsb [options]
|
||||
$ lsb --help
|
||||
usage: lsb [-h] {hide,reveal} ...
|
||||
|
||||
Options:
|
||||
--version show program's version number and exit
|
||||
-h, --help show this help message and exit
|
||||
--hide Hides a message in an image.
|
||||
--reveal Reveals the message hided in an image.
|
||||
-i INPUT_IMAGE_FILE, --input=INPUT_IMAGE_FILE
|
||||
positional arguments:
|
||||
{hide,reveal} sub-command help
|
||||
hide hide help
|
||||
reveal reveal help
|
||||
|
||||
optional arguments:
|
||||
-h, --help show this help message and exit
|
||||
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
$ lsb hide --help
|
||||
usage: lsb hide [-h] -i INPUT_IMAGE_FILE (-m SECRET_MESSAGE | -f SECRET_FILE)
|
||||
-o OUTPUT_IMAGE_FILE
|
||||
|
||||
optional arguments:
|
||||
-h, --help show this help message and exit
|
||||
-i INPUT_IMAGE_FILE, --input INPUT_IMAGE_FILE
|
||||
Input image file.
|
||||
-o OUTPUT_IMAGE_FILE, --output=OUTPUT_IMAGE_FILE
|
||||
-m SECRET_MESSAGE Your secret message to hide (non binary).
|
||||
-f SECRET_FILE Your secret to hide (Text or any binary file).
|
||||
-o OUTPUT_IMAGE_FILE, --output OUTPUT_IMAGE_FILE
|
||||
Output image containing the secret.
|
||||
-m SECRET_MESSAGE, --secret-message=SECRET_MESSAGE
|
||||
Your secret message to hide (non binary).
|
||||
-f SECRET_FILE, --secret-file=SECRET_FILE
|
||||
Your secret to hide (Text or any binary file).
|
||||
-b SECRET_BINARY, --binary=SECRET_BINARY
|
||||
Output for the binary secret (Text or any binary
|
||||
file).
|
||||
|
||||
|
||||
|
||||
Hide and reveal a text message with the LSB method
|
||||
--------------------------------------------------
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
$ lsb --hide -i ./tests/sample-files/Lenna.png -o ./Lenna_enc.png -m HelloWorld!
|
||||
$ lsb --reveal -i ./Lenna_enc.png
|
||||
HelloWorld!
|
||||
$ lsb hide -i ./tests/sample-files/Lenna.png -m 'Hello World!' -o ./Lenna_enc.png
|
||||
$ lsb reveal -i ./Lenna_enc.png
|
||||
Hello World!
|
||||
|
||||
Hide and reveal a binary file
|
||||
-----------------------------
|
||||
|
|
@ -41,9 +50,9 @@ Hide and reveal a binary file
|
|||
.. code-block:: bash
|
||||
|
||||
$ wget http://www.gnu.org/music/free-software-song.ogg
|
||||
$ lsb --hide -i ./tests/sample-files/Montenach.png -o ./Montenach_enc.png -f ./free-software-song.ogg
|
||||
$ lsb hide -i ./tests/sample-files/Montenach.png -f ./free-software-song.ogg -o ./Montenach_enc.png
|
||||
$ rm free-software-song.ogg
|
||||
$ lsb --reveal -i ./Montenach_enc.png -b ./song.ogg
|
||||
$ lsb reveal -i ./Montenach_enc.png -o ./song.ogg
|
||||
|
||||
Hide and reveal a text message with the LSB method and generated sets
|
||||
---------------------------------------------------------------------
|
||||
|
|
@ -52,24 +61,20 @@ Sets are used in order to select the pixels where the message will be hidden.
|
|||
|
||||
.. code-block:: bash
|
||||
|
||||
echo "Hide the message with the Sieve of Eratosthenes..."
|
||||
lsb-set --hide -i ./tests/sample-files/Montenach.png -o ./surprise.png --generator eratosthenes -m 'Joyeux Noël!'
|
||||
echo ""
|
||||
# Hide the message with the Sieve of Eratosthenes
|
||||
lsb-set hide -i ./tests/sample-files/Montenach.png --generator eratosthenes -m 'Joyeux Noël!' -o ./surprise.png
|
||||
|
||||
echo "Try to reveal with Mersenne numbers..."
|
||||
lsb-set --reveal --generator mersenne -i ./surprise.png
|
||||
echo ""
|
||||
# Try to reveal with Mersenne numbers
|
||||
lsb-set reveal --generator mersenne -i ./surprise.png
|
||||
|
||||
echo "Try to reveal with fermat numbers..."
|
||||
lsb-set --reveal --generator fermat -i ./surprise.png
|
||||
echo ""
|
||||
# Try to reveal with fermat numbers
|
||||
lsb-set reveal --generator fermat -i ./surprise.png
|
||||
|
||||
echo "Try to reveal with carmichael numbers..."
|
||||
lsb-set --reveal --generator carmichael -i ./surprise.png
|
||||
echo ""
|
||||
# Try to reveal with carmichael numbers
|
||||
lsb-set reveal --generator carmichael -i ./surprise.png
|
||||
|
||||
echo "Try to reveal with Sieve of Eratosthenes..."
|
||||
lsb-set --reveal --generator eratosthenes -i ./surprise.png
|
||||
# Try to reveal with Sieve of Eratosthenes
|
||||
lsb-set reveal --generator eratosthenes -i ./surprise.png
|
||||
|
||||
|
||||
An other example:
|
||||
|
|
@ -77,16 +82,16 @@ An other example:
|
|||
.. code-block:: bash
|
||||
|
||||
# Hide the message - LSB with a set defined by the identity function (f(x) = x).
|
||||
lsb-set --hide -i ./tests/sample-files/Montenach.png -o ./enc-identity.png --generator identity -m 'I like steganography.'
|
||||
lsb-set hide -i ./tests/sample-files/Montenach.png -o ./enc-identity.png --generator identity -m 'I like steganography.'
|
||||
|
||||
# Hide the message - LSB only.
|
||||
lsb --hide -i ./tests/sample-files/Montenach.png -o ./enc.png -m 'I like steganography.'
|
||||
lsb hide -i ./tests/sample-files/Montenach.png -o ./enc.png -m 'I like steganography.'
|
||||
|
||||
# Check if the two generated files are the same.
|
||||
sha1sum ./enc-identity.png ./enc.png
|
||||
|
||||
# The output of lsb is given to lsb-set.
|
||||
lsb-set --reveal -i ./enc.png --generator identity
|
||||
lsb-set reveal -i ./enc.png --generator identity
|
||||
|
||||
# The output of lsb-set is given to lsb.
|
||||
lsb --reveal -i ./enc-identity.png
|
||||
lsb reveal -i ./enc-identity.png
|
||||
|
|
|
|||
|
|
@ -7,7 +7,7 @@ Parity
|
|||
.. code-block:: bash
|
||||
|
||||
# Hide the message with Sieve of Eratosthenes
|
||||
lsb-set --hide -i ./tests/sample-files/Ginnifer-Goodwin.png -o ./surprise.png --generator eratosthenes -m 'Very important message.'
|
||||
lsb-set hide -i ./tests/sample-files/Ginnifer-Goodwin.png -o ./surprise.png --generator eratosthenes -m 'Very important message.'
|
||||
|
||||
# Steganalysis of the original photo
|
||||
steganalysis-parity -i ./tests/sample-files/Ginnifer-Goodwin.png -o ./surprise_st_original.png
|
||||
|
|
@ -16,4 +16,4 @@ Parity
|
|||
steganalysis-parity -i ./surprise.png -o ./surprise_st_secret.png
|
||||
|
||||
# Reveal with Sieve of Eratosthenes
|
||||
lsb-set --reveal --generator eratosthenes -i ./surprise.png
|
||||
lsb-set reveal --generator eratosthenes -i ./surprise.png
|
||||
|
|
|
|||
2
setup.py
2
setup.py
|
|
@ -28,7 +28,7 @@ with open('CHANGELOG.rst', 'r') as f:
|
|||
|
||||
setup(
|
||||
name='Stegano',
|
||||
version='0.5.5',
|
||||
version='0.6',
|
||||
author='Cédric Bonhomme',
|
||||
author_email='cedric@cedricbonhomme.org',
|
||||
packages=packages,
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue