https://github.com/offdev/zwsp-steg-js

Zero-Width Space Steganography, encodes/decodes hidden messages as non printable/readable characters.
https://github.com/offdev/zwsp-steg-js

Last synced: about 2 months ago
JSON representation

Zero-Width Space Steganography, encodes/decodes hidden messages as non printable/readable characters.

• Host: GitHub
• URL: https://github.com/offdev/zwsp-steg-js
• Owner: offdev
• License: apache-2.0
• Created: 2018-04-15T17:43:39.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2018-09-17T07:26:26.000Z (about 6 years ago)
• Last Synced: 2024-04-09T20:02:58.766Z (6 months ago)
• Language: JavaScript
• Size: 8.79 KB
• Stars: 150
• Watchers: 7
• Forks: 18
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# zwsp-steg

Zero-Width Space Steganography. Encodes and decodes hidden messages as non printable/readable characters. A demo can be found [here](https://offdev.net/demos/zwsp-steg-js).

[![npm](https://img.shields.io/npm/v/zwsp-steg.svg)](https://www.npmjs.com/package/zwsp-steg)

[![Travis](https://img.shields.io/travis/offdev/zwsp-steg-js.svg)](https://travis-ci.org/offdev/zwsp-steg-js)

[![dependencies Status](https://david-dm.org/offdev/zwsp-steg-js/status.svg)](https://david-dm.org/offdev/zwsp-steg-js)

[![devDependencies Status](https://david-dm.org/offdev/zwsp-steg-js/dev-status.svg)](https://david-dm.org/offdev/zwsp-steg-js?type=dev)

[![License](https://img.shields.io/github/license/offdev/zwsp-steg-js.svg)](https://www.apache.org/licenses/LICENSE-2.0)

### Installation

```bash

$ npm install zwsp-steg

```

### Usage Example

```.js

const ZwspSteg = require('zwsp-steg');

let encoded = ZwspSteg.encode('hidden message');

let decoded = ZwspSteg.decode(encoded);

console.log(decoded); // hidden message

```

Note that decoding a message will ignore all non 'special' characters. That means if you hide your message within a readable string, and decode the whole string, you will only return the hidden message.

### Parameters

You can use different sets of characters in different encoding / decoding modes.

```.js

const ZwspSteg = require('zwsp-steg');

ZwspSteg.encode('hidden message', ZwspSteg.MODE_ZWSP);

ZwspSteg.encode('hidden message', ZwspSteg.MODE_FULL);

```

#### Character sets used

- **MODE_ZWSP**: Zero-Width Space (\u200b), Zero-Width Non-Joiner (\u200c), Zero-Width Joiner (\u200d)

- **MODE_FULL**: All MODE_ZWSP characters, Left-To-Right Mark (\u200e), Right-To-Left Mark (\u200f)

### License

[Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0)