xor-it

xor-it is a utility class that will take a key and a text. If the text a simple string it will retun a cipher. If the text is a cipher it will return the original string. It uses the vernam cipher technique to create the cipher

Usage no npm install needed!

<script type="module">
  import xorIt from 'https://cdn.skypack.dev/xor-it';
</script>

README

xor-it

A module to xor strings using vernam cipher technique. Built in ES6, transpiled to ES5 using babel.

Installation

npm install xor-it --save

Usage

To get a cipher from string


var xorIt = require('xor-it');
var cipher = xorIt('you-key-here', 'some-text');

To get string from a cipher


var xorIt = require('xor-it');
var originalText = xorIt('your-key-here', cipher);

ES2015 Example

import xorIt from 'xor-it';

const cipher = xorIt('you-key-here', 'some-text');

Run Code Sample

npm run example

Tests

npm test

Contributing

In lieu of a formal style guide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code.

Release History

  • 2016-03-08 1.0.2 Minor code improvements
  • 2015-09-30 1.0.1 Added tests
  • 2015-09-29 1.0.0 Initial release

License

MIT license; see LICENSE.

(c) 2015-2016 by Abdul Khan and Alexey Novak