Giter Club home page Giter Club logo

ebg13's Introduction

ebg13

Simple Rot13 implementation

Build Status

Basic Rot13 (a.k.a. symmetric Caesar Cipher)

Example use

npm install ebg13
var ebg13 = require('ebg13');

var encodedMessage = ebg13('secret message');

console.log('Decoded message:' + ebg13(encodedMessage));

Asymmetric keys

As Rot13 is just a special case of Caesar Cipher with a symmetric key of 13, version 1.2.0 implements a backward compatible implementation of the algorithm for assymetric keys.

Example use

npm install ebg13
var caesar = require('ebg13');

var encodedMessage = caesar('secret Message', 12);

console.log('Decoded message:' + caesar(encodedMessage, 14));

Generating keys

If you don't want to generate assymetric keys manually, ebg13 comes with a convenience generator.

var keys = require('ebg13/keys')

myKeys = keys.generate();

var encodedMessage = caesar('secret Message', myKeys.public);

console.log('Decoded message:' + caesar(encodedMessage, myKeys.private));

CLI

From version 1.3.0 ebg13 can be used as a command line tool

Usage

 ___________________________________________________________________________________________
/                                                                                           \
| Usage: ebg13 [--generate-keys] [--seed seed] [--key key] message1 [message2 [...]]        |
|                                                                                           |
|   --generate-keys - Generages a pair of assymetric keys to be used for encoding/deconding |
|   --seed seed - uses the seed as the private key and calculates a public key from it      |
|   --key key - [optional] encoding/decoding key (it defaults to 13)                        |
|   message1, message2, ... - a list of at least one message to be encoded/decoded          |
|                                                                                           |
| A non empty list og messages is required for encoding/decoding but is                     |
| not necessary when generating keys.                                                       |
\                                                                                           /
 -------------------------------------------------------------------------------------------
        \   ^__^
         \  (oo)\_______
            (__)\       )\/\
                ||----w |
                ||     ||

examples

$ ebg message --key 2
oguucig
$ ebg message --generate-keys
{ private: 10, public: 16 }
$ ebg message --generate-keys --seed 1
{ private: 1, public: 25 }
$ ebg message secret "secret message"
zrffntr
frperg
frperg zrffntr

Disclaimer

Rot13 is a playful cryptographic algorithm, it's fun, it's even insighful but it's of absolutely no use in practice, it does not provide any level of security. Do not use is on any data that you are not comfortable sharing publicly. You have been warned.

ChangeLog

1.3.0

  • CLI interface

1.2.0

  • Introduction of assymetric keys

ebg13's People

Contributors

guioconnor avatar goloroden avatar

Stargazers

Will Smith avatar

Watchers

 avatar James Cloos avatar

ebg13's Issues

Rotate by 12

I have an important business case to be able to rotate letters by a more secure number. 12 was chosen.

Please implement this.

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.