klefki

Simple substitution cipher module writted in JavaScript.

What is klefki?

Simple substitution cipher module. It basically consists of substituting every plaintext character for a different ciphertext character. It differs from the Caesar cipher in that the cipher alphabet is not simply the alphabet shifted, it is completely jumbled.

Tested!

All code is tested with mocha.

Easy to use

Folow the steps above, simple.

Simple Algorithm

That you can easy understand.

Get Started

INSTALLATION

npm install klefki --save

Usage

    var klefki = require('klefki'),
        _word = 'abracadabra',
        _myKey = 'myKey',
        _cipher = '';
        _cipher = klefki.ciphers.simpleSubstitution.encrypt(_word, _myKey);
        klefki.ciphers.simpleSubstitution.decrypt(_cipher) === _word; // true

TESTS

npm test

CONTRIBUTING

Don't be shy, send a Pull Request! Here is how:

  1. Fork it!
  2. Create your feature branch:
    git checkout -b my-new-feature
  3. Commit your changes:
    git commit -m 'Add some feature'
  4. Push to the branch:
    git push origin my-new-feature
  5. Submit a pull request! :D