Skip to content

README.md

Latest commit

 

History

History
41 lines (22 loc) · 1.82 KB

README.md

File metadata and controls

41 lines (22 loc) · 1.82 KB

Steganographer v1.0.1

Steganographer is a JavaScript/TypeScript library used to encode secret messages inside images and to decode them again. The original project is from https://github.com/petereigenschink/steganography.js by Peter Eigenschink - steganographer removed unused code, adds some quality of life improvements, and allows this to be used easily as a module in JavaScript or TypeScript projects.

Demo

https://hyundotio.github.io/steganographer/dist

How does it work

Behind the scenes steganographer uses an algorithm to convert the given message into appropriate binary data which then will be hidden in the alpha channel of the given cover image. A HTML5 canvas element is then used to process the data and the image. To decode a message from a given image, a similiar algorithm is applied on the imagedata.

How to use it

The use of the library is very simple.

  • For plain HTML, download steganographer.js file from the /dist folder and add <script src="./steganographer.js"></script> and call Steg.decode and Steg.encode

  • When using it as a module, download steganographer from npm: npm i steganographer and add import { decode, encode } from 'steganographer' and plainly call decode and encode in your project.

  • encode takes a message as String and a image as HTMLImageElement or string representing the data-URL of the cover image. Returns the data-URL of the image with the encoded message inside.

  • decode takes a image as HTMLImageElement or string representing the data-URL of the image and returns the message which was found in the image.

To build from source:


npm run build

or


yarn build

License

MIT