"Fossies" - the Fresh Open Source Software Archive

Member "openstego-0.7.4/README" (6 Jun 2020, 8752 Bytes) of package /linux/privat/openstego-0.7.4.zip:


As a special service "Fossies" has tried to format the requested text file into HTML format (style: standard) with prefixed line numbers. Alternatively you can here view or download the uninterpreted source code file. See also the latest Fossies "Diffs" side-by-side code changes report for "README": 0.7.3_vs_0.7.4.

    1 OpenStego v0.7.4
    2 ================
    3 
    4 OpenStego is a steganography application that provides two functionalities:
    5   1. Data Hiding: It can hide any data within a cover file (e.g. images).
    6   2. Watermarking: Watermarking files (e.g. images) with an invisible
    7      signature. It can be used to detect unauthorized file copying.
    8 
    9 For GUI:
   10   java -jar <path>\openstego.jar
   11 
   12 For command line interface:
   13   java -jar <path>\openstego.jar <command> [options]
   14 
   15 The first argument must be a command. Valid commands are:
   16 
   17   embed, --embed                Embed message into cover file
   18   extract, --extract            Extract message from stego file
   19   gensig, --gensig              Generate a signature for watermarking
   20   embedmark, --embedmark        Watermark a cover file using signature
   21   checkmark, --checkmark        Checks for watermark presence in the file
   22   algorithms, --algorithms      List down supported steganography algorithms
   23   readformats --readformats     List down supported formats for cover file
   24   writeformats, --writeformats  List down supported formats for stego file
   25   help, --help                  Display this help. To get help on options
   26                                 specific to an algorithm, provide the name of
   27                                 the algorithm using '-a' option
   28 
   29 Following option is common for all commands other than 'algorithms':
   30 
   31     -a, --algorithm <algorithm_name>
   32         Name of the steganography algorithm to use. List of the supported
   33         algorithms can be retrieved using 'algorithms' command
   34 
   35 'embed' options:
   36 
   37     -mf, --messagefile <filename>
   38         Source message/data file. If this option is not provided or '-'
   39         (without quotes) is provided as the value then the message data is
   40         read from stdin
   41 
   42     -cf, --coverfile <filename>
   43         Cover file in which the message will be embedded. This option supports
   44         '*' and '?' wildcards for filename. If wildcard filename is provided
   45         then make sure that it is surrounded by double quotes.
   46         Multiple filenames can also be provided by separating them with ';'
   47         (semi-colon).
   48         If the wildcard expression returns more than one file, then '-sf'
   49         option is ignored, and each coverfile is overwritten with the
   50         corresponding generated stegofile
   51 
   52     -sf, --stegofile <filename>
   53         Output stego file containing the embedded message. If this option is
   54         not provided or '-' (without quotes) is provided as the value then the
   55         stego file is written to stdout
   56 
   57     -c, --compress
   58         Compress the message file before embedding (default)
   59 
   60     -C, --nocompress
   61         Do not compress the message file before embedding
   62 
   63     -e, --encrypt
   64         Encrypt the message file before embedding
   65 
   66     -E, --noencrypt
   67         Do not encrypt the message file before embedding (default)
   68 
   69     -p, --password <password>
   70         Password to be used for encryption. If this is not provided then
   71         prompt will be displayed for entry
   72 
   73     -A, --cryptalgo <crypto algorithm>
   74         Algorithm to be used for encryption. Defaults to AES128. Possible
   75         values are AES128 or AES256. Please note that AES256 will only be
   76         supported with JRE having unlimited strength jurisdiction policy
   77 
   78 'extract' options:
   79 
   80     -sf, --stegofile <filename>
   81         Stego file containing the embedded message
   82 
   83     -xf, --extractfile <filename>
   84         Optional filename for the extracted data. Use this to override the
   85         filename embedded in the stego file
   86 
   87     -xd, --extractdir <dir>
   88         Directory where the message file will be extracted. If this option is
   89         not provided, then the file is extracted to current directory
   90 
   91     -p, --password <password>
   92         Password to be used for decryption. If this is not provided then
   93         prompt will be displayed for entry (if the message is encrypted)
   94 
   95 'gensig' options:
   96 
   97     -gf, --sigfile <filename>
   98         Output signature file that can be used to watermark files. If this
   99         option is not provided or '-' (without quotes) is provided as the
  100         value then the signature file is written to stdout
  101 
  102     -p, --password <password>
  103         Password to be used for generation of signature. If this is not
  104         provided then prompt will be displayed for entry
  105 
  106 'embedmark' options:
  107 
  108     -gf, --sigfile <filename>
  109         Watermarking signature file. If this option is not provided or '-'
  110         (without quotes) is provided as the value then the signature data is
  111         read from stdin
  112 
  113     -cf, --coverfile <filename>
  114         Cover file which needs to be digitally watermarked. This option supports
  115         '*' and '?' wildcards for filename. If wildcard filename is provided
  116         then make sure that it is surrounded by double quotes.
  117         Multiple filenames can also be provided by separating them with ';'
  118         (semi-colon).
  119         If the wildcard expression returns more than one file, then '-sf'
  120         option is ignored, and each coverfile is overwritten with the
  121         corresponding generated stegofile
  122 
  123     -sf, --stegofile <filename>
  124         Output stego file containing the embedded watermark. If this option is
  125         not provided or '-' (without quotes) is provided as the value then the
  126         stego file is written to stdout
  127 
  128 'checkmark' options:
  129 
  130     -sf, --stegofile <filename>
  131         Stego file containing the embedded watermark
  132 
  133     -gf, --sigfile <filename>
  134         Signature file which was used to watermark the file
  135 
  136 Examples:
  137 
  138   To embed secret.txt into wallpaper.png and generate the output into test.png:
  139 
  140       java -jar <path>\openstego.jar embed -a lsb -mf secret.txt \
  141         -cf wallpaper.png -sf test.png
  142    OR
  143       java -jar <path>\openstego.jar --embed --algorithm=lsb \
  144         --messagefile=secret.txt --coverfile=wallpaper.png --stegofile=test.png
  145 
  146   To extract embedded data from test.png to /data directory:
  147 
  148       java -jar <path>\openstego.jar extract -a lsb -sf test.png -xd /data
  149    OR
  150       java -jar <path>\openstego.jar extract --algorithm=lsb \
  151         --stegofile=test.png --extractdir=/data
  152 
  153   To generate a signature file:
  154 
  155       java -jar <path>\openstego.jar gensig -a dwtxie -gf my.sig
  156    OR
  157       java -jar <path>\openstego.jar --gensig --algorithm=dwtxie \
  158         --sigfile=my.sig
  159 
  160   To embed signature into owned.png and generate the output into out.png:
  161 
  162       java -jar <path>\openstego.jar embedmark -a dwtxie -gf my.sig \
  163         -cf owned.png -sf out.png
  164    OR
  165       java -jar <path>\openstego.jar --embedmark --algorithm=dwtxie \
  166         --sigfile=my.sig --coverfile=owned.png --stegofile=out.png
  167 
  168   To check for watermark in test.png using my.sig signature file:
  169 
  170       java -jar <path>\openstego.jar checkmark -a dwtxie -gf my.sig \
  171         -sf test.png
  172    OR
  173       java -jar <path>\openstego.jar checkmark --algorithm=dwtxie \
  174         --sigfile=my.sig --stegofile=test.png
  175 
  176   Piping example:
  177 
  178       ls -R | java -jar <path>\openstego.jar embed -a lsb > test.png
  179 
  180   Wildcard example (Please note that the double quotes are important):
  181 
  182       java -jar <path>\openstego.jar embed -a lsb \
  183         -cf "img???.png;wall*.png" -mf watermark.txt
  184 
  185 PLUGINS HELP:
  186 -------------
  187 Please use the following command to get plugin specific help:
  188 
  189   java -jar <path>\openstego.jar -help -a <algorithm_name>
  190 
  191 
  192 ADDING NEW PLUGIN:
  193 ------------------
  194   To add a new plugin, the following abstract class must be implemented:
  195 
  196     - com.openstego.desktop.OpenStegoPlugin
  197 
  198   Read the API documentation for the details of the methods to be implemented.
  199   In addition, the following utility class can be used to handle multilingual
  200   string labels for the plugin:
  201 
  202     - com.openstego.desktop.util.LabelUtil
  203 
  204   A new namespace should be added to LabelUtil class for each new plugin. Same
  205   namespace can also be used for exception messages while throwing
  206   OpenStegoException.
  207 
  208   After implementing the plugin classes, create new file named
  209   "OpenStegoPlugins.external" and put the fully qualified name of the class
  210   which implements OpenStegoPlugin in the file. Make sure that this file is
  211   put directly under the CLASSPATH while invoking the application.
  212 
  213   Please refer to the "com.openstego.desktop.plugin.lsb" package sources
  214   for sample plugin implementation.
  215 
  216 AUTHOR:
  217 -------
  218   Samir Vaidya (syvaidya@gmail.com)
  219   Copyright (c) 2007-2020
  220 
  221 SEE ALSO:
  222 ---------
  223   Project homepage: http://www.openstego.com
  224   Blog:             http://syvaidya.blogspot.com
  225 
  226 LICENSE:
  227 --------
  228   GNU General Public License 2.0 (GPL) (see LICENSE file)