Giter Site home page Giter Site logo

autokey's Introduction

Autokey

Build Status Coverage Status

A Go implementation of the simple Autokey cipher. Autokey has some useful characteristics: the output is the same length as the input and looks like the input was merely jumbled as it uses the same alphabet as the input:

  • Input: all our words from loose using have lost their edge.
  • Output: kbu cjd hprjy qmud ilujd xpxkq xxsw hvng zgksj nqwa.

This is similar to and based on the stream cipher implementation at https://github.com/hex7c0/autokey but restricts the input and output to a given alphabet. This means you can let spaces, punctuation, and other characters go through the algorithm with no change.

How it works

To install:

go get github.com/allenluce/autokey

Example usage

package main

import "github.com/allenluce/autokey"

const Alphabet = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz"

func main() {
    // The key does not have to be chosen from the alphabet.
    akey := autokey.NewAutoKey("MyKeyIsThis", Alphabet, 2)

    input := "Something very important!";
    cipherText := akey.Encode(input)
    println(cipherText)
    recoveredText := akey.Decode(cipherText)
    println(recoveredText)
}

NewAutoKey takes a key and an alphabet as the first two arguments. The key should consist of characters from the given alphabet.

The third argument to NewAutoKey is a seed length. When encoding plaintext that consists of many smaller strings with a very high number of duplicates, the regular Autokey cipher will spit out many duplicates on its own. This could allow a viewer to infer values based on the frequency of the duplicated strings.

Using a seed makes this more difficult. A new seed is determined randomly for each call to Encode() and then tacked on the front of the emitted string. This means that output will be larger than input.

A 0 may be given as the seed length to use the regular Autokey algorithm with no random seed.

Caveat

Autokey is a very old cipher with known vulnerabilities and is not as secure as modern encryption systems. You should consider this algorithm as a slightly better alternative to ROT13 or base64 for obfuscating text.

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.