cryptii

Framework and web app for encoding and decoding text.

Quick start

• Make sure you have node & npm, gulp and sass installed locally.
• Clone the repo: git clone -b dev [email protected]:cryptii/cryptii.git
• Install dev dependencies: npm install
• Build repo: gulp build
• Run tests: gulp test
• Watch files: gulp

Core concepts

This framework and web app tries to reflect a wide variety of ciphers, encodings, encryptions and formats while keeping them easily combinable. Here are some basic assumptions that lay out the foundation of this library.

Bricks

There are two categories of Bricks: Encoders and Viewers. Both inherit directly from the Brick class which provides logic for managing settings, a view and serialisation.

Encoder objects manipulate content by encoding or decoding it in a specific way and with given settings.

let encoder = new ROT13Encoder()
encoder.setSettingValue('variant', 'rot47')
let result = encoder.encode('Hello World') // returns a Chain object
result.getString() // returns 'w6==@ (@C=5'

Viewer objects allow users to view and edit content in a specific way or format.

Chains

Chain objects encapsulate the actual content used and returned by Encoders and Viewers. This content can either be a string, an array of Unicode code points or a Uint8Array of bytes.

Chains are immutable. You define its content by passing one of these representations as first argument to the constructor.

let a = new Chain('🦊🚀')
let b = new Chain([129418, 128640])
let c = new Chain(new Uint8Array([240, 159, 166, 138, 240, 159, 154, 128]))
Chain.isEqual(a, b, c) // returns true

The object handles the translation between these representations lazily for you. You can access any of these through getter and additional convenience methods.

let string = chain.getString()
let codePoints = chain.getCodePoints()
let bytes = chain.getBytes()