Giter Club home page Giter Club logo

stegjs's Introduction

stegjs

npm npm Steg.js Test workflow npm

Command-line utility for steganography in PNG images. With this application you can send secret messages, passwords or other important information.

Installation

To install globally you should enter in terminal window the following command:

$ npm i -g stegjs

Help

$ stegjs --help

  Usage: stegjs <image or url>.png [mode] [message] [step] [output]

  Encrypt you message to PNG image.

  Options:

    -h, --help     output usage information
    -V, --version  output the version number
    -e, --encode   Change program mode to encode file.
    -d, --decode   Change program mode to decode file

Syntax information:

[mode]		one of the two modes;
[message]	the message you want to encrypt;
[step]		pattern of the distribution message bits in the alpha channel of the image;
[output]	path where to save the image with the encoded message.

Examples

The program works in two modes, encrypt and decrypt messages.

Encode

To encrypt a message use one of the following commands:

$ npx stegjs img.png -e "Meeting tonight at midnight under the light." 5x5
$ npx stegjs https://upload.wikimedia.org/wikipedia/commons/4/47/PNG_transparency_demonstration_1.png -e "my_secret_pass" 1x1 ./secrets/go.png
$ npx stegjs nyan.png -e "๐Ÿฑ" 2x1

After that in the console, you will see the full path to the output image, message and pattern.

/Users/you/secrets/out.png has been encoded
message: ๐Ÿฑ
pattern: 2x1

Decode

To receive an encrypted message, specify the path to the image with the secret message and add the flag -d.

$ npx stegjs out.png -d

After that in the console, you will see the information contained in the encrypted image.

out.png was decoded
message: ๐Ÿฑ
pattern: 2x1

License

MIT ยฉ Andrey Medvedev

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.