% steganer(1) | steganer usage documentation

NAME

steganer — Library and command to hide a file inside another... or to recover it.

SYNOPSIS

| steganer FILE_HIDDEN HOST_FILE [-x|--extract] [-h|--help] [-V|--version]

USAGE AS CONSOLE COMMAND

If not run in extract mode then you are trying to hide FILE_HIDDEN inside HOST_FILE, whereas if you set extract mode then you are trying to recover FILE_HIDDEN from HOST_FILE.

Hiding a text file example (at first text file is too big, so we compress it before hiding):

$ ls -l
  -rw-rw-r--  1 dante dante  926839 Sep 13 20:33 genesis.txt
  -rw-rw-r--  1 dante dante  550225 Sep 13 20:40 lena.png
$ steganer genesis.txt lena.png
  thread 'main' panicked at 'File to be hidden is too big for this host image. Current is 926839 bytes but maximum for this image is 786336 bytes', src/stegimage.rs:142:13
  note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace.
$ gzip genesis.txt 
$ ls -l
  -rw-rw-r--  1 dante dante  322230 Sep 13 20:33 genesis.txt.gz
  -rw-rw-r--  1 dante dante  550225 Sep 13 20:40 lena.png
$ steganer genesis.txt.gz lena.png

Extracting a hidden file example:

$ ls -l
  -rw-rw-r--  1 dante dante  322230 Sep 13 20:33 genesis.txt.gz
  -rw-rw-r--  1 dante dante  661834 Sep 16 21:47 lena.png
$ steganer genesis_recovered.txt.gz lena.png --extract
$ ls -l
  -rw-rw-r--  1 dante dante  322230 Sep 13 20:33 genesis.txt.gz
  -rw-rw-r--  1 dante dante  322230 Sep 16 21:49 genesis_recovered.txt.gz
  -rw-rw-r--  1 dante dante  661834 Sep 16 21:47 lena.png

Nowadays, steganer performs steganography over images (currently PNG, BMP and PPM images). Method used is to store chunks of data in Least Significant Bits of image pixels. Only metadata steganer stores inside host images is hidden chunk size, so you must know which extension hidden file has prior extraction. Hiding quality depends on image_size/hidden_data_size ratio, so host image should be much bigger than hidden data to keep hiding unnoticed. If you realize host image gets noise after hiding then you should chose another bigger image as host.

Options

-x, --extract

: Run in extract mode.

-h, --help

: Prints brief usage information.

-V, --version

: Prints the current version number.

USAGE AS DEVELOPMENT LIBRARY

Rust

If you use steganer rust library (for instance from crates.io), you currently have next functions available:

pub fn extract_from_image(hidden_file: &str, host_file: &str)-> Result<()>

Extract a file hidden into an image using steganography techniques.

Parameters:
    * hidden_file: Absolute path to file to hide.
    * host_file: Absolute path to image file that is going to contain hidden file

pub fn hide_into_image(file_to_hide: &str, host_file: &str)-> Result<()>

Hide a file into into an image using steganography techniques.

Parameters:
    * file_to_hide: Absolute path to hidden file.
    * host_file: Absolute path to image file that contains hidden file.

Python

A python module is built and uploaded to Pypi each time a new version of steganer rust library is released.

If you use steganer python library (for instance from Pypi), you currently have next functions available:

def unhide_from_image(hidden_file: str, host_file: str)-> PyResult

Exported version of extract_from_image() for python module.

Parameters:
    * hidden_file: Absolute path to file to hide.
    * host_file: Absolute path to image file that is going to contain hidden file.

def hide_inside_image(file_to_hide: str, host_file: str)-> PyResult

Exported version of hide_into_image() for python module.

Parameters:
    * file_to_hide: Absolute path to hidden file.
    * host_file: Absolute path to image file that contains hidden file.

BUGS

Report issues at: https://github.com/dante-signal31/steganer/issues

AUTHOR

Dante Signal31 dante.signal31@gmail.com

SEE ALSO

Website: https://github.com/dante-signal31/steganer

COPYRIGHT

Copyright (c) 2019 Dante-Signal31 dante.signal31@gmail.com. All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this list of conditions and the
following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the
following disclaimer in the documentation and/or other materials provided with the distribution.
3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or
promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.